@cms0/cms0 0.0.9 → 0.0.11

package/dist/types/index.d.ts

@@ -1,16 +1,113 @@
 import { Cms0APIConfig } from "@cms0/cms0/config";
-export type CmsInstance<Schema> = {
-    [K in keyof Schema]: () => Promise<Schema[K]>;
+import { schemaDescriptor } from "@cms0/cms0/schema-descriptors";
+import { FullDescriptor } from "@cms0/shared";
+type QueryValue = string | number | boolean | null | undefined;
+type QueryParam = QueryValue | QueryValue[];
+export type CmsQuery = Record<string, QueryParam>;
+export type CmsResponseMode = "normalized" | "envelope" | "raw";
+export interface CmsAccessorOptions {
+    query?: CmsQuery;
+    response?: CmsResponseMode;
+    includeId?: boolean;
+    resolveModelRefs?: boolean;
+    locale?: string;
+    signal?: AbortSignal;
+}
+export type CmsCollectionEnvelope<T> = {
+    items: T[];
+    total: number;
+};
+type CmsAccessorBaseOptions = Omit<CmsAccessorOptions, "includeId">;
+type WithCollectionItemObjectIds<T> = T extends Array<infer Item> ? Array<Item extends object ? WithCollectionItemObjectIds<Item> & {
+    id: string;
+} : Item> : T extends object ? {
+    [K in keyof T]: WithCollectionItemObjectIds<T[K]>;
+} : T;
+type WithAllObjectIds<T> = T extends Array<infer Item> ? Array<WithAllObjectIds<Item>> : T extends object ? {
+    id: string;
+} & {
+    [K in keyof T]: WithAllObjectIds<T[K]>;
+} : T;
+export type CmsAccessor<T> = {
+    (options: CmsAccessorBaseOptions & {
+        includeId: true;
+    }): Promise<WithAllObjectIds<T>>;
+    (options: CmsAccessorBaseOptions & {
+        includeId: false;
+    }): Promise<T>;
+    (options?: CmsAccessorBaseOptions & {
+        includeId?: undefined;
+    }): Promise<WithCollectionItemObjectIds<T>>;
+};
+type CmsModelByIdAccessor<T> = {
+    (id: string, options: CmsAccessorBaseOptions & {
+        includeId: true;
+    }): Promise<WithAllObjectIds<T> | null>;
+    (id: string, options: CmsAccessorBaseOptions & {
+        includeId: false;
+    }): Promise<T | null>;
+    (id: string, options?: CmsAccessorBaseOptions & {
+        includeId?: undefined;
+    }): Promise<T | null>;
+};
+export type CmsModelAccessor<T> = CmsAccessor<T[]> & {
+    byId: CmsModelByIdAccessor<T>;
 };
+export type CmsInstance<Roots, Models extends Record<string, any> = Record<string, never>> = {
+    [K in keyof Roots]: CmsAccessor<Roots[K]>;
+} & {
+    models: {
+        [K in keyof Models]: CmsModelAccessor<Models[K]>;
+    } & Record<string, CmsModelAccessor<any>>;
+} & Record<string, unknown>;
 export interface Cms0Options {
     apiConfig: Cms0APIConfig;
     locales?: string[];
     defaultLocale?: string;
 }
+type PrimitiveValueFromDescriptor<TypeName extends string> = TypeName extends "string" ? string : TypeName extends "number" ? number : TypeName extends "boolean" ? boolean : any;
+type ApplyDescriptorFlags<Descriptor, Value> = Descriptor extends {
+    optional: true;
+    nullable: true;
+} ? Value | null | undefined : Descriptor extends {
+    optional: true;
+} ? Value | undefined : Descriptor extends {
+    nullable: true;
+} ? Value | null : Value;
+type InferDescriptorObject<Properties extends Record<string, any>, ModelMap extends Record<string, any>> = {
+    [Key in keyof Properties]: InferDescriptorField<Properties[Key], ModelMap>;
+};
+type InferDescriptorField<Descriptor, ModelMap extends Record<string, any>> = ApplyDescriptorFlags<Descriptor, Descriptor extends {
+    kind: "modelRef";
+    model: infer ModelName extends string;
+} ? ModelName extends keyof ModelMap ? ModelMap[ModelName] : string : Descriptor extends {
+    kind: "primitive";
+    type: infer Primitive extends string;
+} ? PrimitiveValueFromDescriptor<Primitive> : Descriptor extends {
+    type: "array";
+    items: infer Items;
+} ? Array<InferDescriptorField<Items, ModelMap>> : Descriptor extends {
+    type: "object";
+    properties: infer Properties extends Record<string, any>;
+} ? InferDescriptorObject<Properties, ModelMap> : Descriptor extends {
+    type: infer Primitive extends string;
+} ? PrimitiveValueFromDescriptor<Primitive> : any>;
+type InferDescriptorModels<Models extends Record<string, any>> = {
+    [ModelName in keyof Models]: Models[ModelName] extends {
+        properties: infer Properties extends Record<string, any>;
+    } ? InferDescriptorObject<Properties, InferDescriptorModels<Models>> : any;
+};
+type InferDescriptorRoots<Roots extends Record<string, any>, Models extends Record<string, any>> = {
+    [RootKey in keyof Roots]: InferDescriptorField<Roots[RootKey], Models>;
+};
+type GeneratedModels = InferDescriptorModels<typeof schemaDescriptor.models>;
+type GeneratedRoots = InferDescriptorRoots<typeof schemaDescriptor.roots, GeneratedModels>;
+export declare function createCmsClient<Roots, Models extends Record<string, any> = Record<string, never>>(descriptor: FullDescriptor, config: Cms0Options): CmsInstance<Roots, Models>;
 /**
  * Initializes the CMS SDK for a given schema.
- * @param config configuration including API base URL or database URL.
- * @returns an object with typed accessors matching the schema.
+ * @param config configuration including API base URL and API key.
+ * @returns typed accessors for root resources and model resources.
  */
-export declare function cms0<Schema>(config: Cms0Options): CmsInstance<Schema>;
+export declare function cms0<Roots = GeneratedRoots, Models extends Record<string, any> = GeneratedModels>(config: Cms0Options): CmsInstance<Roots, Models>;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAKlD,MAAM,MAAM,WAAW,CAAC,MAAM,IAAI;KAC/B,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,GAAG,WAAW,CAAC,MAAM,CAAC,CAkDrE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAGL,cAAc,EACf,MAAM,cAAc,CAAC;AAEtB,KAAK,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;AAC/D,KAAK,UAAU,GAAG,UAAU,GAAG,UAAU,EAAE,CAAC;AAC5C,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;AAElD,MAAM,MAAM,eAAe,GAAG,YAAY,GAAG,UAAU,GAAG,KAAK,CAAC;AAEhE,MAAM,WAAW,kBAAkB;IACjC,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,IAAI;IACrC,KAAK,EAAE,CAAC,EAAE,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,KAAK,sBAAsB,GAAG,IAAI,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;AAEpE,KAAK,2BAA2B,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAC7D,KAAK,CAAC,IAAI,SAAS,MAAM,GAAG,2BAA2B,CAAC,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAAC,GACtF,CAAC,SAAS,MAAM,GACd;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,2BAA2B,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GACrD,CAAC,CAAC;AAER,KAAK,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,IAAI,CAAC,GAClD,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,GAC7B,CAAC,SAAS,MAAM,GACd;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,GAC3D,CAAC,CAAC;AAER,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,CAAC,OAAO,EAAE,sBAAsB,GAAG;QAAE,SAAS,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACtF,CAAC,OAAO,EAAE,sBAAsB,GAAG;QAAE,SAAS,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG;QAAE,SAAS,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CACrE,2BAA2B,CAAC,CAAC,CAAC,CAC/B,CAAC;CACH,CAAC;AAEF,KAAK,oBAAoB,CAAC,CAAC,IAAI;IAC7B,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,GAAG;QAAE,SAAS,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAC1E,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAC3B,CAAC;IACF,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,GAAG;QAAE,SAAS,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACxF,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG;QAAE,SAAS,CAAC,EAAE,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;CAC/F,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,WAAW,CAAC,CAAC,EAAE,CAAC,GAAG;IACnD,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,WAAW,CACrB,KAAK,EACL,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,IACxD;KACD,CAAC,IAAI,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CAC1C,GAAG;IACF,MAAM,EAAE;SACL,CAAC,IAAI,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;KACjD,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3C,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,KAAK,4BAA4B,CAAC,QAAQ,SAAS,MAAM,IAAI,QAAQ,SAAS,QAAQ,GAClF,MAAM,GACN,QAAQ,SAAS,QAAQ,GACvB,MAAM,GACN,QAAQ,SAAS,SAAS,GACxB,OAAO,GACP,GAAG,CAAC;AAEZ,KAAK,oBAAoB,CAAC,UAAU,EAAE,KAAK,IAAI,UAAU,SAAS;IAChE,QAAQ,EAAE,IAAI,CAAC;IACf,QAAQ,EAAE,IAAI,CAAC;CAChB,GACG,KAAK,GAAG,IAAI,GAAG,SAAS,GACxB,UAAU,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GACnC,KAAK,GAAG,SAAS,GACjB,UAAU,SAAS;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,GACnC,KAAK,GAAG,IAAI,GACZ,KAAK,CAAC;AAEd,KAAK,qBAAqB,CACxB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACtC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClC;KACD,GAAG,IAAI,MAAM,UAAU,GAAG,oBAAoB,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC;CAC3E,CAAC;AAEF,KAAK,oBAAoB,CACvB,UAAU,EACV,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAClC,oBAAoB,CACtB,UAAU,EACV,UAAU,SAAS;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,KAAK,EAAE,MAAM,SAAS,SAAS,MAAM,CAAA;CAAE,GAC1E,SAAS,SAAS,MAAM,QAAQ,GAC9B,QAAQ,CAAC,SAAS,CAAC,GACnB,MAAM,GACR,UAAU,SAAS;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,SAAS,SAAS,MAAM,CAAA;CAAE,GAC5E,4BAA4B,CAAC,SAAS,CAAC,GACvC,UAAU,SAAS;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,KAAK,CAAA;CAAE,GACtD,KAAK,CAAC,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,GAC5C,UAAU,SAAS;IACf,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,EAAE,MAAM,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC1D,GACD,qBAAqB,CAAC,UAAU,EAAE,QAAQ,CAAC,GAC3C,UAAU,SAAS;IAAE,IAAI,EAAE,MAAM,SAAS,SAAS,MAAM,CAAA;CAAE,GACzD,4BAA4B,CAAC,SAAS,CAAC,GACvC,GAAG,CAChB,CAAC;AAEF,KAAK,qBAAqB,CACxB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAChC;KACD,SAAS,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,SAAS;QACrD,UAAU,EAAE,MAAM,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC1D,GACG,qBAAqB,CAAC,UAAU,EAAE,qBAAqB,CAAC,MAAM,CAAC,CAAC,GAChE,GAAG;CACR,CAAC;AAEF,KAAK,oBAAoB,CACvB,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACjC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAChC;KACD,OAAO,IAAI,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CACvE,CAAC;AAEF,KAAK,eAAe,GAAG,qBAAqB,CAAC,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAC7E,KAAK,cAAc,GAAG,oBAAoB,CACxC,OAAO,gBAAgB,CAAC,KAAK,EAC7B,eAAe,CAChB,CAAC;AAu3BF,wBAAgB,eAAe,CAC7B,KAAK,EACL,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,EAE1D,UAAU,EAAE,cAAc,EAC1B,MAAM,EAAE,WAAW,GAClB,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAqF5B;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAClB,KAAK,GAAG,cAAc,EACtB,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,eAAe,EACpD,MAAM,EAAE,WAAW,GAAG,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAKjD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cms0/cms0",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "",
   "publishConfig": {
     "access": "restricted"
@@ -75,6 +75,7 @@
     "build:prepare": "pnpm -C ../shared build && node ./scripts/ensure-generated-schema-descriptor.cjs",
     "build:esm": "tsc -p tsconfig.json",
     "build:cjs": "tsc -p tsconfig.cjs.json",
-    "build:finalize": "node ./finalize-build.cjs"
+    "build:finalize": "node ./finalize-build.cjs",
+    "test": "tsx --test test/**/*.test.ts"
   }
 }