@spica-devkit/bucket 0.18.9 → 0.18.11-pre1

package/dist/index.d.ts

@@ -1 +1,126 @@
-export * from "./src/index";
+import { JSONSchema7, JSONSchema7TypeName } from 'json-schema';
+import { Observable } from 'rxjs';
+
+interface SuccessResponse<P, R = P> {
+    request: P;
+    response: R;
+}
+interface FailureResponse<P> {
+    request: P;
+    response: {
+        message: string;
+        error: string;
+    };
+}
+interface ManyResponse<P, R> {
+    successes: SuccessResponse<P, R>[];
+    failures: FailureResponse<P>[];
+}
+
+interface Bucket {
+    _id?: string;
+    title: string;
+    icon?: string;
+    description: string;
+    primary: string;
+    history?: boolean;
+    properties: {
+        [key: string]: JSONSchema7 & PropertyOptions;
+    };
+    order?: number;
+}
+interface PropertyOptions {
+    type: JSONSchema7TypeName | JSONSchema7TypeName[] | string;
+    options: {
+        translate?: boolean;
+        history?: boolean;
+    };
+}
+interface BucketDocument {
+    _id?: string;
+    [key: string]: any | undefined;
+}
+type RealtimeConnection<T> = Observable<T> & {
+    insert: (document: Omit<Singular<T>, "_id">) => void;
+    replace: (document: Singular<T> & {
+        _id: string;
+    }) => void;
+    patch: (document: Partial<Singular<T>> & {
+        _id: string;
+    }) => void;
+    remove: (document: Partial<Singular<T>> & {
+        _id: string;
+    }) => void;
+};
+type RealtimeConnectionOne<T> = Observable<T> & {
+    replace: (document: Omit<Singular<T>, "_id">) => void;
+    patch: (document: Omit<Partial<Singular<T>>, "_id">) => void;
+    remove: () => void;
+};
+type Singular<T> = T extends Array<any> ? T[0] : T;
+
+interface PublicInitialization {
+    publicUrl?: string;
+}
+interface ApikeyInitialization extends PublicInitialization {
+    apikey: string;
+}
+interface IdentityInitialization extends PublicInitialization {
+    identity: string;
+}
+interface IndexResult<T> {
+    meta: {
+        total: number;
+    };
+    data: T[];
+}
+
+declare function initialize(options: ApikeyInitialization | IdentityInitialization): void;
+declare function get(id: string, headers?: object): Promise<Bucket>;
+declare function getAll(headers?: object): Promise<Bucket[]>;
+declare function insert(bucket: Bucket, headers?: object): Promise<Bucket>;
+declare function insertMany(buckets: Bucket[], headers?: object): Promise<ManyResponse<Bucket, Bucket>>;
+declare function update(id: string, bucket: Bucket, headers?: object): Promise<Bucket>;
+declare function remove(id: string, headers?: object): Promise<any>;
+declare function removeMany(ids: string[], headers?: object): Promise<ManyResponse<string, string>>;
+declare namespace data {
+    function get<T>(bucketId: string, documentId: string, options?: {
+        headers?: object;
+        queryParams?: {
+            [key: string]: any;
+        };
+    }): Promise<T>;
+    function getAll<T>(bucketId: string, options?: {
+        headers?: object;
+        queryParams?: {
+            [key: string]: any;
+            paginate?: false;
+        };
+    }): Promise<T[]>;
+    function getAll<T>(bucketId: string, options?: {
+        headers?: object;
+        queryParams?: {
+            [key: string]: any;
+            paginate?: true;
+        };
+    }): Promise<IndexResult<T>>;
+    function insert<T>(bucketId: string, document: Omit<T, "_id">, headers?: object): Promise<T>;
+    function insertMany<T>(bucketId: string, documents: T[], headers?: object): Promise<ManyResponse<T, T>>;
+    function update<T>(bucketId: string, documentId: string, document: T, headers?: object): Promise<T>;
+    function patch(bucketId: string, documentId: string, document: Partial<BucketDocument>, headers?: object): Promise<any>;
+    function remove(bucketId: string, documentId: string, headers?: object): Promise<any>;
+    function removeMany(bucketId: string, documentIds: string[], headers?: object): Promise<ManyResponse<string, string>>;
+    namespace realtime {
+        function get<T>(bucketId: string, documentId: string, messageCallback?: (res: {
+            status: number;
+            message: string;
+        }) => any, queryParams?: object): RealtimeConnectionOne<T>;
+        function getAll<T>(bucketId: string, queryParams?: object, messageCallback?: (res: {
+            status: number;
+            message: string;
+        }) => any): RealtimeConnection<T[]>;
+    }
+}
+
+export { data, get, getAll, initialize, insert, insertMany, remove, removeMany, update };
+export type { Bucket, BucketDocument, RealtimeConnection, RealtimeConnectionOne };