Moduletrace/datasquirel
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
Benjamin Toby 2025-07-05 15:16:31 +01:00
parent 7e8bb37c09
commit 3730e4722e
25 changed files with 58 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
dist/package-shared/api/crud/delete.d.ts vendored
View File

@ -10,12 +10,13 @@ type Params<T extends {
deleteKeyValues?: SQLDeleteData<T>[];
};
targetID?: string | number;
apiKey?: string;
};
export default function apiCrudDELETE<T extends {
[key: string]: any;
} = {
[key: string]: any;
}>({ dbName, tableName, deleteSpec, targetID }: Params<T>): Promise<import("../../types").APIResponseObject<{
}>({ dbName, tableName, deleteSpec, targetID, apiKey }: Params<T>): Promise<import("../../types").APIResponseObject<{
[k: string]: any;
}>>;
export {};

3
dist/package-shared/api/crud/delete.js vendored
View File

@ -1,7 +1,7 @@
import path from "path";
import queryDSQLAPI from "../../functions/api/query-dsql-api";
import grabAPIBasePath from "../../utils/grab-api-base-path";
export default async function apiCrudDELETE({ dbName, tableName, deleteSpec, targetID }) {
export default async function apiCrudDELETE({ dbName, tableName, deleteSpec, targetID, apiKey }) {
const basePath = grabAPIBasePath({ paradigm: "crud" });
const finalID = typeof targetID === "number" ? String(targetID) : targetID;
const finalPath = path.join(basePath, dbName, tableName, finalID || "");
@ -9,6 +9,7 @@ export default async function apiCrudDELETE({ dbName, tableName, deleteSpec, tar
method: "DELETE",
path: finalPath,
body: deleteSpec,
apiKey,
});
return GET_RES;
}

3
dist/package-shared/api/crud/get.d.ts vendored
View File

@ -8,10 +8,11 @@ type Params<T extends {
tableName: string;
query?: DsqlCrudQueryObject<T>;
targetId?: string | number;
apiKey?: string;
};
export default function apiCrudGET<T extends {
[key: string]: any;
} = {
[key: string]: any;
}>({ dbName, tableName, query, targetId, }: Params<T>): Promise<APIResponseObject>;
}>({ dbName, tableName, query, targetId, apiKey, }: Params<T>): Promise<APIResponseObject>;
export {};

3
dist/package-shared/api/crud/get.js vendored
View File

@ -1,7 +1,7 @@
import path from "path";
import queryDSQLAPI from "../../functions/api/query-dsql-api";
import grabAPIBasePath from "../../utils/grab-api-base-path";
export default async function apiCrudGET({ dbName, tableName, query, targetId, }) {
export default async function apiCrudGET({ dbName, tableName, query, targetId, apiKey, }) {
const basePath = grabAPIBasePath({ paradigm: "crud" });
const finalID = typeof targetId === "number" ? String(targetId) : targetId;
const finalPath = path.join(basePath, dbName, tableName, finalID || "");
@ -9,6 +9,7 @@ export default async function apiCrudGET({ dbName, tableName, query, targetId, }
method: "GET",
path: finalPath,
query,
apiKey,
});
return GET_RES;
}

3
dist/package-shared/api/crud/post.d.ts vendored
View File

@ -8,9 +8,10 @@ export type APICrudPostParams<T extends {
tableName: string;
body: T;
update?: boolean;
apiKey?: string;
};
export default function apiCrudPOST<T extends {
[key: string]: any;
} = {
[key: string]: any;
}>({ dbName, tableName, body, update, }: APICrudPostParams<T>): Promise<APIResponseObject>;
}>({ dbName, tableName, body, update, apiKey, }: APICrudPostParams<T>): Promise<APIResponseObject>;

3
dist/package-shared/api/crud/post.js vendored
View File

@ -1,7 +1,7 @@
import path from "path";
import queryDSQLAPI from "../../functions/api/query-dsql-api";
import grabAPIBasePath from "../../utils/grab-api-base-path";
export default async function apiCrudPOST({ dbName, tableName, body, update, }) {
export default async function apiCrudPOST({ dbName, tableName, body, update, apiKey, }) {
const basePath = grabAPIBasePath({ paradigm: "crud" });
const passedID = body.id;
const finalID = update
@ -14,6 +14,7 @@ export default async function apiCrudPOST({ dbName, tableName, body, update, })
method: update ? "PUT" : "POST",
path: finalPath,
body,
apiKey,
});
return GET_RES;
}

3
dist/package-shared/api/crud/put.d.ts vendored
View File

@ -5,10 +5,11 @@ type Params<T extends {
[key: string]: any;
}> = Omit<APICrudPostParams<T>, "update"> & {
targetID: string | number;
apiKey?: string;
};
export default function apiCrudPUT<T extends {
[key: string]: any;
} = {
[key: string]: any;
}>({ dbName, tableName, body, targetID }: Params<T>): Promise<import("../../types").APIResponseObject>;
}>({ dbName, tableName, body, targetID, apiKey }: Params<T>): Promise<import("../../types").APIResponseObject>;
export {};

3
dist/package-shared/api/crud/put.js vendored
View File

@ -1,5 +1,5 @@
import apiCrudPOST from "./post";
export default async function apiCrudPUT({ dbName, tableName, body, targetID }) {
export default async function apiCrudPUT({ dbName, tableName, body, targetID, apiKey }) {
const updatedBody = Object.assign({}, body);
if (targetID) {
updatedBody["id"] = targetID;
@ -9,5 +9,6 @@ export default async function apiCrudPUT({ dbName, tableName, body, targetID })
tableName,
body: updatedBody,
update: true,
apiKey,
});
}

7
dist/package-shared/api/media/delete.d.ts vendored
View File

@ -1,5 +1,8 @@
import { APIResponseObject } from "../../types";
import { DSQL_DATASQUIREL_USER_MEDIA } from "../../types/dsql";
export default function apiMediaDELETE(params: {
type Params = {
mediaID?: string | number;
}): Promise<APIResponseObject<DSQL_DATASQUIREL_USER_MEDIA | DSQL_DATASQUIREL_USER_MEDIA[]>>;
apiKey?: string;
};
export default function apiMediaDELETE(params: Params): Promise<APIResponseObject<DSQL_DATASQUIREL_USER_MEDIA | DSQL_DATASQUIREL_USER_MEDIA[]>>;
export {};

1
dist/package-shared/api/media/delete.js vendored
View File

@ -12,6 +12,7 @@ export default async function apiMediaDELETE(params) {
const DELETE_MEDIA_RES = await queryDSQLAPI({
method: "DELETE",
path: finalPath,
apiKey: params.apiKey,
});
return DELETE_MEDIA_RES;
}

1
dist/package-shared/api/media/get.js vendored
View File

@ -13,6 +13,7 @@ export default async function apiMediaGET(params) {
method: "GET",
path: finalPath,
query: params,
apiKey: params.apiKey,
});
return GET_MEDIA_RES;
}

1
dist/package-shared/api/media/post.js vendored
View File

@ -6,6 +6,7 @@ export default async function apiMediaPOST(params) {
method: "POST",
path: basePath,
body: params,
apiKey: params.apiKey,
});
return POST_MEDIA_RES;
}

4
dist/package-shared/functions/api/query-dsql-api.d.ts vendored
View File

@ -2,12 +2,12 @@ import { APIResponseObject, DataCrudRequestMethods, DataCrudRequestMethodsLowerC
type Param<T = {
[k: string]: any;
}> = {
key?: string;
body?: T;
query?: T;
useDefault?: boolean;
path: string;
method?: (typeof DataCrudRequestMethods)[number] | (typeof DataCrudRequestMethodsLowerCase)[number];
apiKey?: string;
};
/**
* # Query DSQL API
@ -16,5 +16,5 @@ export default function queryDSQLAPI<T = {
[k: string]: any;
}, P = {
[k: string]: any;
}>({ key, body, query, useDefault, path: passedPath, method, }: Param<T>): Promise<APIResponseObject<P>>;
}>({ body, query, useDefault, path: passedPath, method, apiKey, }: Param<T>): Promise<APIResponseObject<P>>;
export {};

4
dist/package-shared/functions/api/query-dsql-api.js vendored
View File

@ -4,7 +4,7 @@ import serializeQuery from "../../utils/serialize-query";
/**
* # Query DSQL API
*/
export default async function queryDSQLAPI({ key, body, query, useDefault, path: passedPath, method, }) {
export default async function queryDSQLAPI({ body, query, useDefault, path: passedPath, method, apiKey, }) {
const grabedHostNames = grabHostNames({ useDefault });
const { host, port, scheme } = grabedHostNames;
try {
@ -17,7 +17,7 @@ export default async function queryDSQLAPI({ key, body, query, useDefault, path:
const reqPayload = body ? JSON.stringify(body) : undefined;
let headers = {
"Content-Type": "application/json",
Authorization: key ||
Authorization: apiKey ||
(!method || method == "GET" || method == "get"
? process.env.DSQL_READ_ONLY_API_KEY
: undefined) ||

2
dist/package-shared/types/index.d.ts vendored
View File

@ -1757,10 +1757,12 @@ export type APIGetMediaParams = {
skipBase64?: "true" | "false";
stream?: "stream";
thumbnail?: "true" | "false";
apiKey?: string;
};
export type AddMediaAPIBody = {
media: MediaUploadDataType[];
folder?: string | null;
type: (typeof MediaTypes)[number];
apiKey?: string;
};
export {};

4
package-shared/api/crud/delete.ts
View File

@ -8,11 +8,12 @@ type Params<T extends { [key: string]: any } = { [key: string]: any }> = {
tableName: string;
deleteSpec?: T & { deleteKeyValues?: SQLDeleteData<T>[] };
targetID?: string | number;
apiKey?: string;
};
export default async function apiCrudDELETE<
T extends { [key: string]: any } = { [key: string]: any }
>({ dbName, tableName, deleteSpec, targetID }: Params<T>) {
>({ dbName, tableName, deleteSpec, targetID, apiKey }: Params<T>) {
const basePath = grabAPIBasePath({ paradigm: "crud" });
const finalID = typeof targetID === "number" ? String(targetID) : targetID;
@ -23,6 +24,7 @@ export default async function apiCrudDELETE<
method: "DELETE",
path: finalPath,
body: deleteSpec,
apiKey,
});
return GET_RES;

3
package-shared/api/crud/get.ts
View File

@ -8,6 +8,7 @@ type Params<T extends { [key: string]: any } = { [key: string]: any }> = {
tableName: string;
query?: DsqlCrudQueryObject<T>;
targetId?: string | number;
apiKey?: string;
};
export default async function apiCrudGET<
@ -17,6 +18,7 @@ export default async function apiCrudGET<
tableName,
query,
targetId,
apiKey,
}: Params<T>): Promise<APIResponseObject> {
const basePath = grabAPIBasePath({ paradigm: "crud" });
@ -28,6 +30,7 @@ export default async function apiCrudGET<
method: "GET",
path: finalPath,
query,
apiKey,
});
return GET_RES;

3
package-shared/api/crud/post.ts
View File

@ -10,6 +10,7 @@ export type APICrudPostParams<
tableName: string;
body: T;
update?: boolean;
apiKey?: string;
};
export default async function apiCrudPOST<
@ -19,6 +20,7 @@ export default async function apiCrudPOST<
tableName,
body,
update,
apiKey,
}: APICrudPostParams<T>): Promise<APIResponseObject> {
const basePath = grabAPIBasePath({ paradigm: "crud" });
@ -36,6 +38,7 @@ export default async function apiCrudPOST<
method: update ? "PUT" : "POST",
path: finalPath,
body,
apiKey,
});
return GET_RES;

4
package-shared/api/crud/put.ts
View File

@ -5,11 +5,12 @@ type Params<T extends { [key: string]: any } = { [key: string]: any }> = Omit<
"update"
> & {
targetID: string | number;
apiKey?: string;
};
export default async function apiCrudPUT<
T extends { [key: string]: any } = { [key: string]: any }
>({ dbName, tableName, body, targetID }: Params<T>) {
>({ dbName, tableName, body, targetID, apiKey }: Params<T>) {
const updatedBody = { ...body } as any;
if (targetID) {
@ -21,5 +22,6 @@ export default async function apiCrudPUT<
tableName,
body: updatedBody,
update: true,
apiKey,
});
}

10
package-shared/api/media/delete.ts
View File

@ -4,9 +4,14 @@ import { DSQL_DATASQUIREL_USER_MEDIA } from "../../types/dsql";
import path from "path";
import grabAPIBasePath from "../../utils/grab-api-base-path";
export default async function apiMediaDELETE(params: {
type Params = {
mediaID?: string | number;
}): Promise<
apiKey?: string;
};
export default async function apiMediaDELETE(
params: Params
): Promise<
APIResponseObject<
DSQL_DATASQUIREL_USER_MEDIA | DSQL_DATASQUIREL_USER_MEDIA[]
>
@ -24,6 +29,7 @@ export default async function apiMediaDELETE(params: {
const DELETE_MEDIA_RES = await queryDSQLAPI({
method: "DELETE",
path: finalPath,
apiKey: params.apiKey,
});
return DELETE_MEDIA_RES as APIResponseObject<

1
package-shared/api/media/get.ts
View File

@ -25,6 +25,7 @@ export default async function apiMediaGET(
method: "GET",
path: finalPath,
query: params,
apiKey: params.apiKey,
});
return GET_MEDIA_RES as APIResponseObject<

1
package-shared/api/media/post.ts
View File

@ -16,6 +16,7 @@ export default async function apiMediaPOST(
method: "POST",
path: basePath,
body: params,
apiKey: params.apiKey,
});
return POST_MEDIA_RES as APIResponseObject<

6
package-shared/functions/api/query-dsql-api.ts
View File

@ -10,7 +10,6 @@ import grabHostNames from "../../utils/grab-host-names";
import serializeQuery from "../../utils/serialize-query";
type Param<T = { [k: string]: any }> = {
key?: string;
body?: T;
query?: T;
useDefault?: boolean;
@ -18,6 +17,7 @@ type Param<T = { [k: string]: any }> = {
method?:
| (typeof DataCrudRequestMethods)[number]
| (typeof DataCrudRequestMethodsLowerCase)[number];
apiKey?: string;
};
/**
@ -27,12 +27,12 @@ export default async function queryDSQLAPI<
T = { [k: string]: any },
P = { [k: string]: any }
>({
key,
body,
query,
useDefault,
path: passedPath,
method,
apiKey,
}: Param<T>): Promise<APIResponseObject<P>> {
const grabedHostNames = grabHostNames({ useDefault });
const { host, port, scheme } = grabedHostNames;
@ -49,7 +49,7 @@ export default async function queryDSQLAPI<
let headers: OutgoingHttpHeaders = {
"Content-Type": "application/json",
Authorization:
key ||
apiKey ||
(!method || method == "GET" || method == "get"
? process.env.DSQL_READ_ONLY_API_KEY
: undefined) ||

2
package-shared/types/index.ts
View File

@ -2268,10 +2268,12 @@ export type APIGetMediaParams = {
skipBase64?: "true" | "false";
stream?: "stream";
thumbnail?: "true" | "false";
apiKey?: string;
};
export type AddMediaAPIBody = {
media: MediaUploadDataType[];
folder?: string | null;
type: (typeof MediaTypes)[number];
apiKey?: string;
};

2
package.json
View File

@ -1,6 +1,6 @@
{
"name": "@moduletrace/datasquirel",
"version": "4.7.5",
"version": "4.7.6",
"description": "Cloud-based SQL data management tool",
"main": "dist/index.js",
"bin": {