nimbu-js-sdk 2.0.0-beta.2 → 2.0.0-beta.4

package/README.md

@@ -4,20 +4,27 @@ The SDK for building Javascript apps on top of Nimbu
 
 ## Development
 
-1. Run `yarn install`
-2. Start the webpack dev server with `yarn run start`
-3. Visit http://localhost:8080/ (will open automatically)
-4. Play around in the console
+1. Run `pnpm install`
+2. Run `pnpm test --ci --coverage --maxWorkers=2`
+3. Run `pnpm build`
+4. Run `pnpm size`
+5. Run `pnpm package-smoke`
 
 ## Releasing
 
-1. Run `yarn run build`
+1. Use Node 22 or newer.
+2. Run `pnpm lint`
+3. Run `pnpm test --ci --coverage --maxWorkers=2`
+4. Run `pnpm build`
+5. Run `pnpm size`
+6. Run `pnpm package-smoke`
 
-The files for distribution are placed in `dist`
+The package entrypoints and browser bundles are placed in `dist`. The tracked
+browser files are `dist/nimbu.js` and `dist/nimbu.min.js`.
 
 ## Version 0.5.2
 
-The build system has switched to `webpack` for version 1.0.0. A copy of the last
+The build system switched to `webpack` for version 1.0.0. A copy of the last
 release before that (0.5.2) is available in the `build` directory.
 
 ## Breaking changes
@@ -47,6 +54,6 @@ to `Nimbu.initialize()`, so you know it already :-)
 
 ### Nimbu.initialize
 
-`Nimbu.initialize` now returns a `Nimbu.Future` that resolves when all
+`Nimbu.initialize` returns a `Promise` that resolves when all
 initialization is finished. You should wait for it to resolve before using the
 SDK.

package/dist/index.d.ts

@@ -1,53 +1,80 @@
-import { NimbuACL, NimbuAPI, NimbuCloud, NimbuCollection, NimbuCoupon, NimbuCustomer, NimbuDevice, NimbuFile, NimbuGallery, NimbuGalleryImage, NimbuObject, NimbuOrder, NimbuPage, NimbuProduct, NimbuProductAggregate, NimbuPush, NimbuQuery, NimbuRelation, NimbuRole, NimbuSelectOption, NimbuSelectOptionList, NimbuError, IAjax, IStorage, ChannelConfig, Select, MultiSelect } from './internal';
+import { AtomicAdd, AtomicAddUnique, AtomicGallery, AtomicIncrement, AtomicRelation, AtomicRemove, AtomicRemoveFile, AtomicSet, AtomicUnset, NimbuACL, NimbuAPI, NimbuAtomic, NimbuCloud, NimbuCollection, NimbuCoupon, NimbuCustomer, NimbuDevice, NimbuFile, NimbuGallery, NimbuGalleryImage, NimbuObject, NimbuOrder, NimbuPage, NimbuProduct, NimbuProductAggregate, NimbuPush, NimbuQuery, NimbuRelation, NimbuRole, NimbuSelectOption, NimbuSelectOptionList, NimbuError, atomicFromJSON } from './internal';
+import type { ChannelConfig, Select, MultiSelect } from './internal';
+import _ from 'underscore';
+declare const Atomic: typeof NimbuAtomic & {
+    Set: typeof AtomicSet;
+    Unset: typeof AtomicUnset;
+    Increment: typeof AtomicIncrement;
+    Add: typeof AtomicAdd;
+    AddUnique: typeof AtomicAddUnique;
+    Remove: typeof AtomicRemove;
+    Relation: typeof AtomicRelation;
+    RemoveFile: typeof AtomicRemoveFile;
+    Gallery: typeof AtomicGallery;
+    _decode: typeof atomicFromJSON;
+};
 declare const Nimbu: {
     VERSION: string;
+    _: _.UnderscoreStatic;
     ACL: typeof NimbuACL;
     API: {
-        get: <T extends Record<string, any>>(path: string, options?: import("./internal").APIRequestOptions | undefined) => Promise<import("./internal").AjaxResponse<T>>;
-        post: <T_1 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<import("./internal").AjaxResponse<T_1>>;
-        put: <T_2 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<import("./internal").AjaxResponse<T_2>>;
-        patch: <T_3 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<import("./internal").AjaxResponse<T_3>>;
-        delete: (path: string, options?: import("./internal").APIRequestOptions | undefined) => Promise<import("./internal").AjaxResponse<Record<string, any>>>;
-        request: <T_4 extends Record<string, any>>(method: string, path: string, data: any, options?: import("./internal").APIRequestOptions) => Promise<import("./internal").AjaxResponse<T_4>>;
+        get: <T extends Record<string, any>>(path: string, options?: import("./internal").APIRequestOptions | undefined) => Promise<T>;
+        post: <T_1 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<T_1>;
+        put: <T_2 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<T_2>;
+        patch: <T_3 extends Record<string, any>>(path: string, data: any, options?: import("./internal").APIRequestOptions | undefined) => Promise<T_3>;
+        delete: (path: string, options?: import("./internal").APIRequestOptions | undefined) => Promise<Record<string, any>>;
+        request: <T_4 extends Record<string, any>>(method: string, path: string, data: any, options?: import("./internal").APIRequestOptions) => Promise<T_4>;
+    };
+    Atomic: typeof NimbuAtomic & {
+        Set: typeof AtomicSet;
+        Unset: typeof AtomicUnset;
+        Increment: typeof AtomicIncrement;
+        Add: typeof AtomicAdd;
+        AddUnique: typeof AtomicAddUnique;
+        Remove: typeof AtomicRemove;
+        Relation: typeof AtomicRelation;
+        RemoveFile: typeof AtomicRemoveFile;
+        Gallery: typeof AtomicGallery;
+        _decode: typeof atomicFromJSON;
     };
     Cloud: {
         run: <T_5 extends Record<string, any> = any>(name: string, data: any) => Promise<T_5>;
     };
     Config: {
         get<U extends ChannelConfig = ChannelConfig, K extends keyof {
-            Ajax?: IAjax | undefined;
+            Ajax?: import("./internal").IAjax | undefined;
             endpoint: string;
             isNode: boolean;
             OAuth2Manager?: import("./internal").OAuth2 | undefined;
             SessionManager?: import("./internal").ISessionManager<U> | undefined;
             StateManager?: import("./internal").IStateManager | undefined;
-            Storage?: IStorage | undefined;
+            Storage?: import("./internal").IStorage | undefined;
             useACL: boolean;
             useSSO: boolean;
             version: string;
             accessToken?: string | undefined;
             installationId?: string | undefined;
         } = never, T_6 extends boolean = false>(key: K, allowNull?: T_6): T_6 extends true ? {
-            Ajax?: IAjax | undefined;
+            Ajax?: import("./internal").IAjax | undefined;
             endpoint: string;
             isNode: boolean;
             OAuth2Manager?: import("./internal").OAuth2 | undefined;
             SessionManager?: import("./internal").ISessionManager<ChannelConfig> | undefined;
             StateManager?: import("./internal").IStateManager | undefined;
-            Storage?: IStorage | undefined;
+            Storage?: import("./internal").IStorage | undefined;
             useACL: boolean;
             useSSO: boolean;
             version: string;
             accessToken?: string | undefined;
             installationId?: string | undefined;
         }[K] | undefined : {
-            Ajax?: IAjax | undefined;
+            Ajax?: import("./internal").IAjax | undefined;
             endpoint: string;
             isNode: boolean;
             OAuth2Manager?: import("./internal").OAuth2 | undefined;
             SessionManager?: import("./internal").ISessionManager<ChannelConfig> | undefined;
             StateManager?: import("./internal").IStateManager | undefined;
-            Storage?: IStorage | undefined;
+            Storage?: import("./internal").IStorage | undefined;
             useACL: boolean;
             useSSO: boolean;
             version: string;
@@ -55,26 +82,26 @@ declare const Nimbu: {
             installationId?: string | undefined;
         }[K];
         set<K_1 extends keyof {
-            Ajax?: IAjax | undefined;
+            Ajax?: import("./internal").IAjax | undefined;
             endpoint: string;
             isNode: boolean;
             OAuth2Manager?: import("./internal").OAuth2 | undefined;
             SessionManager?: import("./internal").ISessionManager<ChannelConfig> | undefined;
             StateManager?: import("./internal").IStateManager | undefined;
-            Storage?: IStorage | undefined;
+            Storage?: import("./internal").IStorage | undefined;
             useACL: boolean;
             useSSO: boolean;
             version: string;
             accessToken?: string | undefined;
             installationId?: string | undefined;
         }>(key: K_1, value: {
-            Ajax?: IAjax | undefined;
+            Ajax?: import("./internal").IAjax | undefined;
             endpoint: string;
             isNode: boolean;
             OAuth2Manager?: import("./internal").OAuth2 | undefined;
             SessionManager?: import("./internal").ISessionManager<ChannelConfig> | undefined;
             StateManager?: import("./internal").IStateManager | undefined;
-            Storage?: IStorage | undefined;
+            Storage?: import("./internal").IStorage | undefined;
             useACL: boolean;
             useSSO: boolean;
             version: string;
@@ -95,12 +122,12 @@ declare const Nimbu: {
         readonly initialized: boolean;
         get installationId(): string | undefined;
         set installationId(value: string);
-        readonly ajax: IAjax;
-        setAjax(fn: IAjax): void;
+        readonly ajax: import("./internal").IAjax;
+        setAjax(fn: import("./internal").IAjax): void;
         setStateManager(manager: import("./internal").IStateManager): void;
         getStateManager(): import("./internal").IStateManager;
-        setStorage(storage: IStorage): void;
-        getStorage(): IStorage;
+        setStorage(storage: import("./internal").IStorage): void;
+        getStorage(): import("./internal").IStorage;
         setSessionManager<T_7 extends ChannelConfig>(manager: import("./internal").ISessionManager<T_7>): void;
         getSessionManager<T_8 extends ChannelConfig>(): import("./internal").ISessionManager<T_8>;
     };
@@ -135,10 +162,14 @@ declare const Nimbu: {
     Role: typeof NimbuRole;
     SelectOption: typeof NimbuSelectOption;
     SelectOptionList: typeof NimbuSelectOptionList;
-    setAjax: (fn: IAjax) => void;
-    setStorage: (storage: IStorage) => void;
+    setAjax: (fn: import("./internal").IAjax) => void;
+    setStorage: (storage: import("./internal").IStorage) => void;
+    setStorageEngine: (storage: import("./internal").IStorage) => void;
     useACL: () => void;
-    useSSO: (sso: boolean) => boolean;
+    useSSO: (sso?: boolean) => boolean;
 };
-export { ChannelConfig, Select, MultiSelect, NimbuACL, NimbuAPI, NimbuCloud, NimbuCollection, NimbuCoupon, NimbuCustomer, NimbuDevice, NimbuFile, NimbuGallery, NimbuGalleryImage, NimbuObject, NimbuOrder, NimbuPage, NimbuProduct, NimbuProductAggregate, NimbuPush, NimbuQuery, NimbuRelation, NimbuRole, NimbuSelectOption, NimbuSelectOptionList, NimbuError, };
+export type { ChannelConfig, Select, MultiSelect };
+export type { IStorage, SyncStorage, AsyncStorage, IAjax, RequestMethod, RequestOptions, IProgressHandler, IOptions, AjaxHeaders, AjaxResponse, ISetOptions, IGetOptions, ICommonFields, Reference, NimbuObjectLike, PersistedNimbuCustomer, NimbuGalleryImageJSON, AuthOptions, InitialOAuth2AccessToken, APIRequestOptions, NimbuQueryOptions, IStateManager, ILoginOptions, ISessionManager, AttributeMap, AtomicsMap, ObjectCache, State, ObjectIdentifier, EncodeOptions, } from './internal';
+export { Atomic, NimbuAtomic, NimbuACL, NimbuAPI, NimbuCloud, NimbuCollection, NimbuCoupon, NimbuCustomer, NimbuDevice, NimbuFile, NimbuGallery, NimbuGalleryImage, NimbuObject, NimbuOrder, NimbuPage, NimbuProduct, NimbuProductAggregate, NimbuPush, NimbuQuery, NimbuRelation, NimbuRole, NimbuSelectOption, NimbuSelectOptionList, NimbuError, };
+export { OAuth2, TaskQueue, LocalStorage, MemoryStorage, BrowserSessionStorage } from './internal';
 export default Nimbu;

package/dist/internal.d.ts

@@ -1,11 +1,14 @@
-export declare const VERSION = "2.0.0.alpha.2";
-export * from './utils/types';
+export type * from './utils/types';
+export type * from './sdk/storage-types';
+export * from './sdk/version';
 export * from './sdk/object';
 export * from './sdk/atomic';
+export * from './sdk/atomic-json';
 export * from './sdk/acl';
 export * from './sdk/api';
 export * from './sdk/collection';
 export * from './sdk/config';
+export * from './sdk/initialize';
 export * from './sdk/coupon';
 export * from './sdk/customer';
 export * from './sdk/customer-sessions';
@@ -28,12 +31,14 @@ export * from './sdk/role';
 export * from './sdk/oauth2';
 export * from './sdk/select-option';
 export * from './sdk/select-option-list';
+export * from './sdk/default-storages';
 export * from './sdk/storage';
 export * from './sdk/state';
 export * from './utils/array-contains-object';
 export * from './utils/decode';
 export * from './utils/encode';
 export * from './utils/promise-utils';
+export * from './utils/sdk-type-guards';
 export * from './utils/traverse';
 export * from './utils/unique';
 export * from './utils/task-queue';