@api-client/core 0.18.33 → 0.18.35

package/build/src/sdk/SdkMock.d.ts

@@ -0,0 +1,301 @@
+import type { StoreSdk } from './StoreSdkWeb.js';
+/**
+ * Options for customizing mock responses.
+ */
+export interface MockResponseOptions {
+    /**
+     * Custom response data to return instead of generated random data.
+     */
+    data?: unknown;
+    /**
+     * HTTP status code to return. Defaults to 200.
+     */
+    status?: number;
+    /**
+     * Custom headers to include in the response.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * A stub reference that can be used to restore the original behavior.
+ */
+export interface StubReference {
+    /**
+     * Restores the original behavior.
+     */
+    restore: () => void;
+}
+/**
+ * SDK mocking utility for testing. Provides simple API to mock SDK calls
+ * with random or custom responses.
+ *
+ * @example
+ * ```typescript
+ * import { SdkMock } from '@api-client/core/sdk/SdkMock.js';
+ * import { StoreSdk } from '@api-client/core/sdk/StoreSdkWeb.js';
+ *
+ * const sdk = new StoreSdk('http://localhost:8080');
+ * const mocker = new SdkMock(sdk);
+ *
+ * // Simple usage - returns random valid organization
+ * const stub1 = mocker.organizations.list();
+ *
+ * // Custom response
+ * const stub2 = mocker.organizations.create({
+ *   data: { key: 'org-1', name: 'Test Org', ... }
+ * });
+ *
+ * // Custom status and headers
+ * const stub3 = mocker.users.me({
+ *   status: 404,
+ *   headers: { 'X-Custom': 'value' }
+ * });
+ *
+ * // Restore all stubs
+ * mocker.restore();
+ * ```
+ */
+export declare class SdkMock {
+    private sdk;
+    private stubs;
+    constructor(sdk: StoreSdk);
+    /**
+     * Organization API mocks.
+     */
+    organizations: {
+        /**
+         * Mocks the `organizations.list()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        list: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `organizations.create()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        create: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `organizations.read()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        read: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `organizations.delete()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        delete: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Group API mocks.
+     */
+    groups: {
+        /**
+         * Mocks the `groups.list()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        list: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `groups.create()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        create: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `groups.read()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        read: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `groups.update()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        update: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `groups.delete()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        delete: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * User API mocks.
+     */
+    users: {
+        /**
+         * Mocks the `user.me()` method.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        me: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Auth API mocks.
+     */
+    auth: {
+        /**
+         * Mocks the `auth.oauthRedirect()` method.
+         * This method returns `null` by default as it performs window navigation.
+         * @param options Optional response customization.
+         * @returns A stub reference that can be used to restore the original behavior.
+         */
+        oauthRedirect: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Files API mocks.
+     */
+    file: {
+        /**
+         * Mocks the `file.list()` method.
+         */
+        list: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.createMeta()` method.
+         */
+        createMeta: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.createMedia()` method.
+         */
+        createMedia: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.create()` method.
+         */
+        create: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.createFolder()` method.
+         */
+        createFolder: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.read()` method.
+         */
+        read: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.readMedia()` method.
+         */
+        readMedia: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.readBulk()` method.
+         */
+        readBulk: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.patch()` method.
+         */
+        patch: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.patchMedia()` method.
+         */
+        patchMedia: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.delete()` method.
+         */
+        delete: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.deleteBulk()` method.
+         */
+        deleteBulk: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.patchUsers()` method.
+         */
+        patchUsers: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.addUser()` method.
+         */
+        addUser: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.removeUser()` method.
+         */
+        removeUser: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.listUsers()` method.
+         */
+        listUsers: (options?: MockResponseOptions) => StubReference;
+        /**
+         * Mocks the `file.breadcrumbs()` method.
+         */
+        breadcrumbs: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Shared API mocks.
+     */
+    shared: {
+        list: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Trash API mocks.
+     */
+    trash: {
+        list: (options?: MockResponseOptions) => StubReference;
+        delete: (options?: MockResponseOptions) => StubReference;
+        restore: (options?: MockResponseOptions) => StubReference;
+        empty: (options?: MockResponseOptions) => StubReference;
+    };
+    /**
+     * Restores all stubs created by this mocker.
+     */
+    restore(): void;
+    /**
+     * Creates a stub for a specific SDK method.
+     * @param api The API name (e.g., 'organizations', 'groups', 'user', 'auth').
+     * @param method The method name to stub.
+     * @param implementation The stub implementation that returns the mocked data.
+     * @returns A stub reference.
+     */
+    private createStub;
+    /**
+     * Creates a response object from data and options.
+     * @param defaultData Default data to return if not overridden.
+     * @param options Response options.
+     * @returns The final data to return (for non-HTTP responses) or IStoreResponse (for HTTP responses).
+     */
+    private createResponse;
+    /**
+     * Generates a random organization object.
+     */
+    private generateOrganization;
+    /**
+     * Generates a random group object.
+     */
+    private generateGroup;
+    /**
+     * Generates a random user object.
+     */
+    private generateUser;
+    /**
+     * Generates a random file meta object.
+     */
+    private generateFile;
+    /**
+     * Generates a random folder meta object.
+     */
+    private generateFolder;
+    /**
+     * Generates a random media patch revision object.
+     */
+    private generateMediaPatchRevision;
+    /**
+     * Generates a random breadcrumbs list.
+     */
+    private generateBreadcrumbs;
+    /**
+     * Generates a random trash entry.
+     */
+    private generateTrashEntry;
+    /**
+     * Generates a random string.
+     */
+    private randomString;
+    /**
+     * Returns a random choice from an array.
+     */
+    private randomChoice;
+    /**
+     * Generates a random hex color.
+     */
+    private randomColor;
+}
+//# sourceMappingURL=SdkMock.d.ts.map

package/build/src/sdk/SdkMock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SdkMock.d.ts","sourceRoot":"","sources":["../../../src/sdk/SdkMock.ts"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAIhD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,OAAO;IAGN,OAAO,CAAC,GAAG;IAFvB,OAAO,CAAC,KAAK,CAAsB;gBAEf,GAAG,EAAE,QAAQ;IAEjC;;OAEG;IACH,aAAa;QACX;;;;WAIG;yBACc,mBAAmB,KAAG,aAAa;QAapD;;;;WAIG;2BACgB,mBAAmB,KAAG,aAAa;QAUtD;;;;WAIG;yBACc,mBAAmB,KAAG,aAAa;QAUpD;;;;WAIG;2BACgB,mBAAmB,KAAG,aAAa;MASvD;IAED;;OAEG;IACH,MAAM;QACJ;;;;WAIG;yBACc,mBAAmB,KAAG,aAAa;QAapD;;;;WAIG;2BACgB,mBAAmB,KAAG,aAAa;QAWtD;;;;WAIG;yBACc,mBAAmB,KAAG,aAAa;QAUpD;;;;WAIG;2BACgB,mBAAmB,KAAG,aAAa;QAUtD;;;;WAIG;2BACgB,mBAAmB,KAAG,aAAa;MASvD;IAED;;OAEG;IACH,KAAK;QACH;;;;WAIG;uBACY,mBAAmB,KAAG,aAAa;MASnD;IAED;;OAEG;IACH,IAAI;QACF;;;;;WAKG;kCACuB,mBAAmB,KAAG,aAAa;MAW9D;IAED;;OAEG;IACH,IAAI;QACF;;WAEG;yBACc,mBAAmB,KAAG,aAAa;QAYpD;;WAEG;+BACoB,mBAAmB,KAAG,aAAa;QAW1D;;WAEG;gCACqB,mBAAmB,KAAG,aAAa;QAU3D;;WAEG;2BACgB,mBAAmB,KAAG,aAAa;QAWtD;;WAEG;iCACsB,mBAAmB,KAAG,aAAa;QAW5D;;WAEG;yBACc,mBAAmB,KAAG,aAAa;QAUpD;;WAEG;8BACmB,mBAAmB,KAAG,aAAa;QAUzD;;WAEG;6BACkB,mBAAmB,KAAG,aAAa;QAYxD;;WAEG;0BACe,mBAAmB,KAAG,aAAa;QAUrD;;WAEG;+BACoB,mBAAmB,KAAG,aAAa;QAU1D;;WAEG;2BACgB,mBAAmB,KAAG,aAAa;QAUtD;;WAEG;+BACoB,mBAAmB,KAAG,aAAa;QAU1D;;WAEG;+BACoB,mBAAmB,KAAG,aAAa;QAU1D;;WAEG;4BACiB,mBAAmB,KAAG,aAAa;QAUvD;;WAEG;+BACoB,mBAAmB,KAAG,aAAa;QAU1D;;WAEG;8BACmB,mBAAmB,KAAG,aAAa;QAYzD;;WAEG;gCACqB,mBAAmB,KAAG,aAAa;MAW5D;IAED;;OAEG;IACH,MAAM;yBACa,mBAAmB,KAAG,aAAa;MAWrD;IAED;;OAEG;IACH,KAAK;yBACc,mBAAmB,KAAG,aAAa;2BAWjC,mBAAmB,KAAG,aAAa;4BASlC,mBAAmB,KAAG,aAAa;0BASrC,mBAAmB,KAAG,aAAa;MAStD;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;IAKf;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAsClB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAOtB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAW5B;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,YAAY;IAmBpB;;OAEG;IACH,OAAO,CAAC,YAAY;IAMpB;;OAEG;IACH,OAAO,CAAC,cAAc;IAKtB;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAYlC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAS3B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,OAAO,CAAC,YAAY;IAIpB;;OAEG;IACH,OAAO,CAAC,WAAW;CAKpB"}