@appweaver/client 1.3.1 → 1.4.0

package/cjs/clients/modules/resource-client.d.ts

@@ -2,6 +2,7 @@ import { BaseModule, RequestOptions } from './base-module';
 import { BaseClientInterface } from '../base-client-interface';
 import { FileDataResponse } from '../responses';
 import { RESOURCE_OPERATIONS, RESOURCE_TYPES } from '../../constants';
+import { ResourceId } from '../../types';
 export type ResourceType = Record<(typeof RESOURCE_TYPES)[number], unknown>;
 export type ResourceInterface = {
     [K in keyof typeof RESOURCE_OPERATIONS]: (...args: any[]) => Promise<any>;
@@ -10,13 +11,13 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
     readonly basePath: string;
     constructor(client: BaseClientInterface, basePath: string);
     /**
-     * Fetches a single resource by its numeric ID.
+     * Fetches a single resource by its ID.
      *
-     * @param {number} id - The ID of the resource to retrieve.
+     * @param {ResourceId} id - The ID of the resource to retrieve.
      * @param {RequestOptions} options - Additional request options (headers, query params, etc.).
      * @returns The resource record matching the given ID.
      */
-    find(id: number, options?: RequestOptions): Promise<Resource['single']>;
+    find(id: ResourceId, options?: RequestOptions): Promise<Resource['single']>;
     /**
      * Executes a query against the resource collection.
      *
@@ -49,16 +50,16 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
      * @returns The updated resource record.
      */
     update(resource: Resource['update'] & {
-        id: number;
+        id: ResourceId;
     }, options?: RequestOptions): Promise<Resource['single']>;
     /**
-     * Deletes a resource record by its numeric ID.
+     * Deletes a resource record by its ID.
      *
-     * @param {number} id - The ID of the resource to delete.
+     * @param {ResourceId} id - The ID of the resource to delete.
      * @param {RequestOptions} options - Additional request options.
      * @returns The deleted resource record.
      */
-    delete(id: number, options?: RequestOptions): Promise<Resource['single']>;
+    delete(id: ResourceId, options?: RequestOptions): Promise<Resource['single']>;
     /**
      * Exports resource records as a file (e.g., CSV) and returns a streaming response.
      *
@@ -72,19 +73,19 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
      *
      * Each entry in `files` maps a field name to a single `File` or an array of `File` objects.
      *
-     * @param {number} id - The ID of the resource for which to upload files.
+     * @param {ResourceId} id - The ID of the resource for which to upload files.
      * @param {Object} files - A map of field names to the file(s) to upload.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource.
      */
-    uploadFiles(id: number, files: Resource['fileUpload'], options?: RequestOptions): Promise<Resource['files']>;
+    uploadFiles(id: ResourceId, files: Resource['fileUpload'], options?: RequestOptions): Promise<Resource['files']>;
     /**
      * Removes specific files from the resource record.
      *
-     * @param {number} id - The ID of the resource for which to delete files.
+     * @param {ResourceId} id - The ID of the resource for which to delete files.
      * @param {Object} files - The file deletion payload identifying which files to remove.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource after deletion.
      */
-    deleteFiles(id: number, files: Resource['fileDelete'], options?: RequestOptions): Promise<Resource['files']>;
+    deleteFiles(id: ResourceId, files: Resource['fileDelete'], options?: RequestOptions): Promise<Resource['files']>;
 }

package/cjs/clients/modules/resource-client.js

@@ -9,9 +9,9 @@ class ResourceClient extends base_module_1.BaseModule {
         this.basePath = basePath;
     }
     /**
-     * Fetches a single resource by its numeric ID.
+     * Fetches a single resource by its ID.
      *
-     * @param {number} id - The ID of the resource to retrieve.
+     * @param {ResourceId} id - The ID of the resource to retrieve.
      * @param {RequestOptions} options - Additional request options (headers, query params, etc.).
      * @returns The resource record matching the given ID.
      */
@@ -85,9 +85,9 @@ class ResourceClient extends base_module_1.BaseModule {
         });
     }
     /**
-     * Deletes a resource record by its numeric ID.
+     * Deletes a resource record by its ID.
      *
-     * @param {number} id - The ID of the resource to delete.
+     * @param {ResourceId} id - The ID of the resource to delete.
      * @param {RequestOptions} options - Additional request options.
      * @returns The deleted resource record.
      */
@@ -125,7 +125,7 @@ class ResourceClient extends base_module_1.BaseModule {
      *
      * Each entry in `files` maps a field name to a single `File` or an array of `File` objects.
      *
-     * @param {number} id - The ID of the resource for which to upload files.
+     * @param {ResourceId} id - The ID of the resource for which to upload files.
      * @param {Object} files - A map of field names to the file(s) to upload.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource.
@@ -156,7 +156,7 @@ class ResourceClient extends base_module_1.BaseModule {
     /**
      * Removes specific files from the resource record.
      *
-     * @param {number} id - The ID of the resource for which to delete files.
+     * @param {ResourceId} id - The ID of the resource for which to delete files.
      * @param {Object} files - The file deletion payload identifying which files to remove.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource after deletion.

package/cjs/index.d.ts

@@ -1,2 +1,3 @@
 export * from './clients';
 export * from './errors';
+export * from './types/resource';

package/cjs/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./clients"), exports);
 __exportStar(require("./errors"), exports);
+__exportStar(require("./types/resource"), exports);

package/cjs/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './generator';
+export * from './resource';
 export * from './routes';

package/cjs/types/index.js

@@ -15,4 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./generator"), exports);
+__exportStar(require("./resource"), exports);
 __exportStar(require("./routes"), exports);

package/cjs/types/resource.d.ts

@@ -0,0 +1,2 @@
+/** Primary key value: a number for `int` and `bigInt` ids, a string for `string` ids */
+export type ResourceId = number | string;

package/cjs/types/resource.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/esm/clients/modules/resource-client.d.ts

@@ -2,6 +2,7 @@ import { BaseModule, RequestOptions } from './base-module.js';
 import { BaseClientInterface } from '../base-client-interface.js';
 import { FileDataResponse } from '../responses/index.js';
 import { RESOURCE_OPERATIONS, RESOURCE_TYPES } from '../../constants.js';
+import { ResourceId } from '../../types/index.js';
 export type ResourceType = Record<(typeof RESOURCE_TYPES)[number], unknown>;
 export type ResourceInterface = {
     [K in keyof typeof RESOURCE_OPERATIONS]: (...args: any[]) => Promise<any>;
@@ -10,13 +11,13 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
     readonly basePath: string;
     constructor(client: BaseClientInterface, basePath: string);
     /**
-     * Fetches a single resource by its numeric ID.
+     * Fetches a single resource by its ID.
      *
-     * @param {number} id - The ID of the resource to retrieve.
+     * @param {ResourceId} id - The ID of the resource to retrieve.
      * @param {RequestOptions} options - Additional request options (headers, query params, etc.).
      * @returns The resource record matching the given ID.
      */
-    find(id: number, options?: RequestOptions): Promise<Resource['single']>;
+    find(id: ResourceId, options?: RequestOptions): Promise<Resource['single']>;
     /**
      * Executes a query against the resource collection.
      *
@@ -49,16 +50,16 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
      * @returns The updated resource record.
      */
     update(resource: Resource['update'] & {
-        id: number;
+        id: ResourceId;
     }, options?: RequestOptions): Promise<Resource['single']>;
     /**
-     * Deletes a resource record by its numeric ID.
+     * Deletes a resource record by its ID.
      *
-     * @param {number} id - The ID of the resource to delete.
+     * @param {ResourceId} id - The ID of the resource to delete.
      * @param {RequestOptions} options - Additional request options.
      * @returns The deleted resource record.
      */
-    delete(id: number, options?: RequestOptions): Promise<Resource['single']>;
+    delete(id: ResourceId, options?: RequestOptions): Promise<Resource['single']>;
     /**
      * Exports resource records as a file (e.g., CSV) and returns a streaming response.
      *
@@ -72,19 +73,19 @@ export declare class ResourceClient<Resource extends ResourceType> extends BaseM
      *
      * Each entry in `files` maps a field name to a single `File` or an array of `File` objects.
      *
-     * @param {number} id - The ID of the resource for which to upload files.
+     * @param {ResourceId} id - The ID of the resource for which to upload files.
      * @param {Object} files - A map of field names to the file(s) to upload.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource.
      */
-    uploadFiles(id: number, files: Resource['fileUpload'], options?: RequestOptions): Promise<Resource['files']>;
+    uploadFiles(id: ResourceId, files: Resource['fileUpload'], options?: RequestOptions): Promise<Resource['files']>;
     /**
      * Removes specific files from the resource record.
      *
-     * @param {number} id - The ID of the resource for which to delete files.
+     * @param {ResourceId} id - The ID of the resource for which to delete files.
      * @param {Object} files - The file deletion payload identifying which files to remove.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource after deletion.
      */
-    deleteFiles(id: number, files: Resource['fileDelete'], options?: RequestOptions): Promise<Resource['files']>;
+    deleteFiles(id: ResourceId, files: Resource['fileDelete'], options?: RequestOptions): Promise<Resource['files']>;
 }

package/esm/clients/modules/resource-client.js

@@ -6,9 +6,9 @@ export class ResourceClient extends BaseModule {
         this.basePath = basePath;
     }
     /**
-     * Fetches a single resource by its numeric ID.
+     * Fetches a single resource by its ID.
      *
-     * @param {number} id - The ID of the resource to retrieve.
+     * @param {ResourceId} id - The ID of the resource to retrieve.
      * @param {RequestOptions} options - Additional request options (headers, query params, etc.).
      * @returns The resource record matching the given ID.
      */
@@ -82,9 +82,9 @@ export class ResourceClient extends BaseModule {
         });
     }
     /**
-     * Deletes a resource record by its numeric ID.
+     * Deletes a resource record by its ID.
      *
-     * @param {number} id - The ID of the resource to delete.
+     * @param {ResourceId} id - The ID of the resource to delete.
      * @param {RequestOptions} options - Additional request options.
      * @returns The deleted resource record.
      */
@@ -122,7 +122,7 @@ export class ResourceClient extends BaseModule {
      *
      * Each entry in `files` maps a field name to a single `File` or an array of `File` objects.
      *
-     * @param {number} id - The ID of the resource for which to upload files.
+     * @param {ResourceId} id - The ID of the resource for which to upload files.
      * @param {Object} files - A map of field names to the file(s) to upload.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource.
@@ -153,7 +153,7 @@ export class ResourceClient extends BaseModule {
     /**
      * Removes specific files from the resource record.
      *
-     * @param {number} id - The ID of the resource for which to delete files.
+     * @param {ResourceId} id - The ID of the resource for which to delete files.
      * @param {Object} files - The file deletion payload identifying which files to remove.
      * @param {RequestOptions} options - Additional request options.
      * @returns The updated file metadata for the resource after deletion.

package/esm/index.d.ts

@@ -1,2 +1,3 @@
 export * from './clients/index.js';
 export * from './errors/index.js';
+export * from './types/resource.js';

package/esm/index.js

@@ -1,2 +1,3 @@
 export * from './clients/index.js';
 export * from './errors/index.js';
+export * from './types/resource.js';

package/esm/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './generator.js';
+export * from './resource.js';
 export * from './routes.js';

package/esm/types/index.js

@@ -1,2 +1,3 @@
 export * from './generator.js';
+export * from './resource.js';
 export * from './routes.js';

package/esm/types/resource.d.ts

@@ -0,0 +1,2 @@
+/** Primary key value: a number for `int` and `bigInt` ids, a string for `string` ids */
+export type ResourceId = number | string;

package/esm/types/resource.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appweaver/client",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Appweaver - the backend framework for AI-first development (@client)",
   "author": "Luka Matosevic",
   "license": "MIT",