@starlightcms/js-sdk 0.9.0 → 0.10.0

package/dist/esm/selectors/Model/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAQA,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AAErD,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC9B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;QACtC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import {\n  Model,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ModelSelector, ProxiedModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n  client: StarlightClient\n): ProxiedModelSelector<D> {\n  const modelClient: ModelSelector = {\n    list(): Promise<StarlightListResponse<Model>> {\n      return client.get('/models')\n    },\n\n    get(slug): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${slug}`)\n    },\n  }\n\n  return new Proxy(modelClient, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedModelSelector<D>\n}\n\nexport { ModelSelector, ProxiedModelSelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAQA,OAAO,iBAAiB,MAAM,uBAAuB,CAAA;AAErD,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAuB;IAEvB,MAAM,WAAW,GAAkB;QACjC,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC9B,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;QACtC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,WAAW,EAAE;QAC5B,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC","sourcesContent":["import {\n  Model,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ModelSelector, DynamicModelSelector } from './types'\nimport makeModelInstance from '../../instances/Model'\n\nexport default function makeModelSelector<D extends WorkspaceModelDefinition>(\n  client: StarlightClient\n): DynamicModelSelector<D> {\n  const modelClient: ModelSelector = {\n    list(): Promise<StarlightListResponse<Model>> {\n      return client.get('/models')\n    },\n\n    get(slug): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${slug}`)\n    },\n  }\n\n  return new Proxy(modelClient, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicModelSelector<D>\n}\n\nexport { ModelSelector, DynamicModelSelector }\n"]}

package/dist/esm/selectors/Model/types.d.ts

@@ -1,10 +1,10 @@
 import { Model, StarlightItemResponse, StarlightListResponse, WorkspaceModelDefinition } from '../../types';
-import { ProxiedModelInstance } from '../../instances/Model';
+import { DynamicModelInstance } from '../../instances/Model';
 export interface ModelSelector {
     list(): Promise<StarlightListResponse<Model>>;
     get(slug: string): Promise<StarlightItemResponse<Model>>;
 }
-export declare type ProxiedModelSelector<T extends WorkspaceModelDefinition> = ModelSelector & {
-    [K in keyof T]: ProxiedModelInstance<T[K]>;
+export declare type DynamicModelSelector<T extends WorkspaceModelDefinition> = ModelSelector & {
+    [K in keyof T]: DynamicModelInstance<T[K]>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/Model/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Model,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { ProxiedModelInstance } from '../../instances/Model'\n\nexport interface ModelSelector {\n  list(): Promise<StarlightListResponse<Model>>\n  get(slug: string): Promise<StarlightItemResponse<Model>>\n}\n\nexport type ProxiedModelSelector<T extends WorkspaceModelDefinition> =\n  ModelSelector & {\n    [K in keyof T]: ProxiedModelInstance<T[K]>\n  }\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  Model,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WorkspaceModelDefinition,\n} from '../../types'\nimport { DynamicModelInstance } from '../../instances/Model'\n\nexport interface ModelSelector {\n  list(): Promise<StarlightListResponse<Model>>\n  get(slug: string): Promise<StarlightItemResponse<Model>>\n}\n\nexport type DynamicModelSelector<T extends WorkspaceModelDefinition> =\n  ModelSelector & {\n    [K in keyof T]: DynamicModelInstance<T[K]>\n  }\n"]}

package/dist/esm/selectors/ModelCategory/index.d.ts

@@ -1,5 +1,5 @@
 import { SerializedData, StarlightClient } from '../../types';
-import { ModelCategorySelector, ProxiedModelCategorySelector } from './types';
-export default function makeModelCategorySelector<D extends SerializedData>(client: StarlightClient, model: string): ProxiedModelCategorySelector<D>;
-export { ModelCategorySelector, ProxiedModelCategorySelector };
+import { ModelCategorySelector, DynamicModelCategorySelector } from './types';
+export default function makeModelCategorySelector<D extends SerializedData>(client: StarlightClient, model: string): DynamicModelCategorySelector<D>;
+export { ModelCategorySelector, DynamicModelCategorySelector };
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/selectors/ModelCategory/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAQA,OAAO,yBAAyB,MAAM,+BAA+B,CAAA;AAErE,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1D,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACzB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategorySelector, ProxiedModelCategorySelector } from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): ProxiedModelCategorySelector<D> {\n  const selector: ModelCategorySelector = {\n    list(options): Promise<StarlightListResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories`, options)\n    },\n\n    get(slug): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelCategoryInstance(client, model, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as ProxiedModelCategorySelector<D>\n}\n\nexport { ModelCategorySelector, ProxiedModelCategorySelector }\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/index.ts"],"names":[],"mappings":"AAQA,OAAO,yBAAyB,MAAM,+BAA+B,CAAA;AAErE,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAA0B;QACtC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,aAAa,EAAE,OAAO,CAAC,CAAA;QAC3D,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,IAAI,EAAE,CAAC,CAAA;QAC1D,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE;QACzB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,yBAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAoC,CAAA;AACvC,CAAC","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategorySelector, DynamicModelCategorySelector } from './types'\nimport makeModelCategoryInstance from '../../instances/ModelCategory'\n\nexport default function makeModelCategorySelector<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): DynamicModelCategorySelector<D> {\n  const selector: ModelCategorySelector = {\n    list(options): Promise<StarlightListResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories`, options)\n    },\n\n    get(slug): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelCategoryInstance(client, model, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicModelCategorySelector<D>\n}\n\nexport { ModelCategorySelector, DynamicModelCategorySelector }\n"]}

package/dist/esm/selectors/ModelCategory/types.d.ts

@@ -10,7 +10,7 @@ export interface ModelCategorySelector {
     list(options?: ListModelCategoriesOptions): Promise<StarlightListResponse<ModelCategory>>;
     get(slug: string): Promise<StarlightItemResponse<ModelCategory>>;
 }
-export declare type ProxiedModelCategorySelector<D extends SerializedData> = ModelCategorySelector & {
+export declare type DynamicModelCategorySelector<D extends SerializedData> = ModelCategorySelector & {
     [slug: string]: ModelCategoryInstance<D>;
 };
 //# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/ModelCategory/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\nexport type ListModelCategoriesOptions = {\n  query?: string\n  page?: number\n  limit?: number\n  order?: 'title:asc' | 'title:desc' | 'entry_count:asc' | 'entry_count:desc'\n}\n\nexport interface ModelCategorySelector {\n  list(\n    options?: ListModelCategoriesOptions\n  ): Promise<StarlightListResponse<ModelCategory>>\n  get(slug: string): Promise<StarlightItemResponse<ModelCategory>>\n}\n\nexport type ProxiedModelCategorySelector<D extends SerializedData> =\n  ModelCategorySelector & {\n    [slug: string]: ModelCategoryInstance<D>\n  }\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  ModelCategory,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance } from '../../instances/ModelCategory'\n\nexport type ListModelCategoriesOptions = {\n  query?: string\n  page?: number\n  limit?: number\n  order?: 'title:asc' | 'title:desc' | 'entry_count:asc' | 'entry_count:desc'\n}\n\nexport interface ModelCategorySelector {\n  list(\n    options?: ListModelCategoriesOptions\n  ): Promise<StarlightListResponse<ModelCategory>>\n  get(slug: string): Promise<StarlightItemResponse<ModelCategory>>\n}\n\nexport type DynamicModelCategorySelector<D extends SerializedData> =\n  ModelCategorySelector & {\n    [slug: string]: ModelCategoryInstance<D>\n  }\n"]}

package/dist/esm/types/entities.d.ts

@@ -1,13 +1,28 @@
+/**
+ * Base interface used by all entities returned by the API.
+ *
+ * @internal
+ */
 interface StarlightEntity {
     id: number;
     created_at: string;
     updated_at?: string;
 }
+/**
+ * Represents a Model Category entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface ModelCategory extends StarlightEntity {
     title: string;
     slug: string;
     entry_count?: number;
 }
+/**
+ * Represents a Media File entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface MediaFile extends StarlightEntity {
     variation: string;
     path: string;
@@ -16,6 +31,11 @@ export interface MediaFile extends StarlightEntity {
     filesize: number;
     meta?: Record<string, unknown>;
 }
+/**
+ * Represents a Media Object entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface MediaObject extends StarlightEntity {
     name: string;
     extension: string;
@@ -24,19 +44,84 @@ export interface MediaObject extends StarlightEntity {
     alt?: string;
     description?: string;
 }
+/**
+ * Represents an Author entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Author {
     id: number;
     name: string;
 }
+/**
+ * Represents a Model entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Model extends StarlightEntity {
     title: string;
     slug: string;
     entry_count?: number;
 }
+/**
+ * Represents content data returned by either an Entry or
+ * Singleton entity from the API.
+ */
 export declare type SerializedData = Record<string, unknown> | undefined;
+/**
+ * Utility type that creates a string map of all fields of the given
+ * SerializedData type with the `field` suffix. This is only useful to create
+ * request methods that support field querying using the "field:foo" syntax.
+ *
+ * @internal
+ */
 export declare type ModelFieldOptions<D extends SerializedData> = {
     [K in keyof D as `field:${string & K}`]?: string;
 };
+/**
+ * Represents an Entry entity returned by the API.
+ *
+ * An Entry's `data` field can be further typed by passing an object-like
+ * structure as the D generic type. This is useful to provide type-safety to
+ * your application, since the `data` field is a generic JS object by default.
+ *
+ * It's recommended to use the Field types provided by this SDK to type your
+ * entities using a type definition file on your project. For instance:
+ *
+ * ```ts
+ * // starlight.d.ts file
+ * import { VisualField, MediaField } from '@starlightcms/js-sdk'
+ *
+ * type PostFields = {
+ *   featured_image: MediaField
+ *   content: VisualField
+ * }
+ *
+ * declare module '@starlightcms/js-sdk' {
+ *   export interface DefaultModelDefinition {
+ *     posts: PostFields
+ *   }
+ * }
+ * ```
+ *
+ * You can place this type definition file anywhere in your repository, but it's
+ * good practice to place it at the same level as your root index.ts file. Then,
+ * in your files, all SDK calls will correctly type `posts`:
+ *
+ * ```ts
+ * import Starlight from '@starlightcms/js-sdk'
+ *
+ * // response type will be StarlightItemResponse<Entry<PostFields>> on request success
+ * const response = await Starlight.posts.entries.get('hello-world')
+ *
+ * // helloWorld type is Entry<PostFields>
+ * const helloWorld = response.data
+ * ```
+ *
+ * See {@apilink DefaultModelDefinition} for more info.
+ *
+ * @group API Entities
+ */
 export interface Entry<D extends SerializedData> extends Omit<StarlightEntity, 'created_at'> {
     title: string;
     slug: string;
@@ -46,21 +131,94 @@ export interface Entry<D extends SerializedData> extends Omit<StarlightEntity, '
     category: ModelCategory | null;
     published_at: string | null;
 }
+/**
+ * Represents a Singleton entity returned by the API.
+ *
+ * A Singleton's `data` field can be further typed by passing an object-like
+ * structure as the D generic type. This is useful to provide type-safety to
+ * your application, since the `data` field is a generic JS object by default.
+ *
+ * It's recommended to use the Field types provided by this SDK to type your
+ * Singletons. For instance:
+ *
+ * ```ts
+ * import { StringField, VisualField, MediaField } from '@starlightcms/js-sdk'
+ *
+ * type HomeFields = {
+ *   site_title: StringField
+ *   hero_image: MediaField
+ *   hero_content: VisualField
+ * }
+ *
+ * // response type will be StarlightItemResponse<Singleton<HomeFields>> on request success
+ * const response = Starlight.singletons.get<HomeFields>('home')
+ *
+ * // home type is Singleton<HomeFields>
+ * const home = response.data
+ * ```
+ *
+ * You could also place all your Singleton field types in the same type
+ * definition file used to configure Entry fields, which makes it easier to
+ * import these types in other files on your project. See
+ * {@apilink DefaultModelDefinition} for more info.
+ *
+ * @group API Entities
+ */
 export interface Singleton<D extends SerializedData> extends Omit<StarlightEntity, 'created_at'> {
     title: string;
     slug: string;
     data: D;
     published_at: string | null;
 }
+/**
+ * Currently supported Collection types. This type is mainly used to provide
+ * autocompletion on IDEs, since it lets users use any string as well as the
+ * known supported types.
+ *
+ * @internal
+ */
 export declare type CollectionTypes = 'entry' | 'singleton' | 'media' | string;
+/**
+ * Currently supported Collection entities. This type is mainly used to infer
+ * the collection type string (see {@link CollectionTypes}) from the type of
+ * entity that that Collection holds.
+ *
+ * @internal
+ */
+export declare type CollectionEntityTypes = Entry<never> | Singleton<never> | MediaObject | unknown;
+/**
+ * Infers a Collection type from an entity type. See {@link CollectionTypes} and
+ * {@link CollectionEntityTypes} to know more.
+ *
+ * @internal
+ */
+export declare type CollectionTypeMapper<T extends CollectionEntityTypes> = T extends Entry<any> ? 'entry' : T extends Singleton<any> ? 'singleton' : T extends MediaObject ? 'media' : string;
+/**
+ * Represents a Collection entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Collection<T extends CollectionTypes = string> extends StarlightEntity {
     title: string;
     slug: string;
     type: T;
     item_count?: number;
 }
+/**
+ * Currently supported Relation types.
+ */
 declare type RelationTypes = Entry<never> | Singleton<never> | MediaObject | Collection | unknown;
+/**
+ * Represents a Relation entity returned by the API.
+ *
+ * @group API Entities
+ */
 export interface Relation<T extends RelationTypes> {
+    /**
+     * The relation type, which is always a string. If the `object` field of this
+     * Relation is an Entry, type will be `entry`, if it's a Singleton, type will
+     * be `singleton`, and so on.
+     */
     type: T extends Entry<never> ? 'entry' : T extends Singleton<never> ? 'singleton' : T extends MediaObject ? 'media' : T extends Collection ? 'collection' : string;
     id: number;
     object: T;

package/dist/esm/types/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/types/entities.ts"],"names":[],"mappings":"AAAA,UAAU,eAAe;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,SAAU,SAAQ,eAAe;IAChD,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,KAAM,SAAQ,eAAe;IAC5C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;AAEhE,oBAAY,iBAAiB,CAAC,CAAC,SAAS,cAAc,IAAI;KACvD,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM;CACjD,CAAA;AAED,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,cAAc,CAC7C,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,cAAc,CACjD,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED,oBAAY,eAAe,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAA;AAEtE,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,eAAe,GAAG,MAAM,CAC5D,SAAQ,eAAe;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,aAAK,aAAa,GACd,KAAK,CAAC,KAAK,CAAC,GACZ,SAAS,CAAC,KAAK,CAAC,GAChB,WAAW,GACX,UAAU,GACV,OAAO,CAAA;AAEX,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,aAAa;IAC/C,IAAI,EAAE,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GACxB,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,KAAK,CAAC,GAC1B,WAAW,GACX,CAAC,SAAS,WAAW,GACrB,OAAO,GACP,CAAC,SAAS,UAAU,GACpB,YAAY,GACZ,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,CAAC,CAAA;CACV"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../src/types/entities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,UAAU,eAAe;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAU,SAAQ,eAAe;IAChD,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,EAAE,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe;IAC5C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,oBAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;AAEhE;;;;;;GAMG;AACH,oBAAY,iBAAiB,CAAC,CAAC,SAAS,cAAc,IAAI;KACvD,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM;CACjD,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,cAAc,CAC7C,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,SAAS,cAAc,CACjD,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED;;;;;;GAMG;AACH,oBAAY,eAAe,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAA;AAEtE;;;;;;GAMG;AACH,oBAAY,qBAAqB,GAC7B,KAAK,CAAC,KAAK,CAAC,GACZ,SAAS,CAAC,KAAK,CAAC,GAChB,WAAW,GACX,OAAO,CAAA;AAEX;;;;;GAKG;AACH,oBAAY,oBAAoB,CAAC,CAAC,SAAS,qBAAqB,IAE9D,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAChB,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,GAAG,CAAC,GACxB,WAAW,GACX,CAAC,SAAS,WAAW,GACrB,OAAO,GACP,MAAM,CAAA;AAEZ;;;;GAIG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,eAAe,GAAG,MAAM,CAC5D,SAAQ,eAAe;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,aAAK,aAAa,GACd,KAAK,CAAC,KAAK,CAAC,GACZ,SAAS,CAAC,KAAK,CAAC,GAChB,WAAW,GACX,UAAU,GACV,OAAO,CAAA;AAEX;;;;GAIG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,SAAS,aAAa;IAC/C;;;;OAIG;IACH,IAAI,EAAE,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,GACxB,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,KAAK,CAAC,GAC1B,WAAW,GACX,CAAC,SAAS,WAAW,GACrB,OAAO,GACP,CAAC,SAAS,UAAU,GACpB,YAAY,GACZ,MAAM,CAAA;IACV,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,CAAC,CAAA;CACV"}

package/dist/esm/types/entities.js.map

@@ -1 +1 @@
-{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/types/entities.ts"],"names":[],"mappings":"","sourcesContent":["interface StarlightEntity {\n  id: number\n  created_at: string\n  updated_at?: string\n}\n\nexport interface ModelCategory extends StarlightEntity {\n  title: string\n  slug: string\n  entry_count?: number\n}\n\nexport interface MediaFile extends StarlightEntity {\n  variation: string\n  path: string\n  mime: string\n  background_color?: string\n  filesize: number\n  meta?: Record<string, unknown>\n}\n\nexport interface MediaObject extends StarlightEntity {\n  name: string\n  extension: string\n  mime: string\n  files: MediaFile[]\n  alt?: string\n  description?: string\n}\n\nexport interface Author {\n  id: number\n  name: string\n}\n\nexport interface Model extends StarlightEntity {\n  title: string\n  slug: string\n  entry_count?: number\n}\n\nexport type SerializedData = Record<string, unknown> | undefined\n\nexport type ModelFieldOptions<D extends SerializedData> = {\n  [K in keyof D as `field:${string & K}`]?: string\n}\n\nexport interface Entry<D extends SerializedData>\n  extends Omit<StarlightEntity, 'created_at'> {\n  title: string\n  slug: string\n  data: D\n  author: Author\n  model?: Model\n  category: ModelCategory | null\n  published_at: string | null\n}\n\nexport interface Singleton<D extends SerializedData>\n  extends Omit<StarlightEntity, 'created_at'> {\n  title: string\n  slug: string\n  data: D\n  published_at: string | null\n}\n\nexport type CollectionTypes = 'entry' | 'singleton' | 'media' | string\n\nexport interface Collection<T extends CollectionTypes = string>\n  extends StarlightEntity {\n  title: string\n  slug: string\n  type: T\n  item_count?: number\n}\n\ntype RelationTypes =\n  | Entry<never>\n  | Singleton<never>\n  | MediaObject\n  | Collection\n  | unknown\n\nexport interface Relation<T extends RelationTypes> {\n  type: T extends Entry<never>\n    ? 'entry'\n    : T extends Singleton<never>\n    ? 'singleton'\n    : T extends MediaObject\n    ? 'media'\n    : T extends Collection\n    ? 'collection'\n    : string\n  id: number\n  object: T\n}\n"]}
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../../src/types/entities.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Base interface used by all entities returned by the API.\n *\n * @internal\n */\ninterface StarlightEntity {\n  id: number\n  created_at: string\n  updated_at?: string\n}\n\n/**\n * Represents a Model Category entity returned by the API.\n *\n * @group API Entities\n */\nexport interface ModelCategory extends StarlightEntity {\n  title: string\n  slug: string\n  entry_count?: number\n}\n\n/**\n * Represents a Media File entity returned by the API.\n *\n * @group API Entities\n */\nexport interface MediaFile extends StarlightEntity {\n  variation: string\n  path: string\n  mime: string\n  background_color?: string\n  filesize: number\n  meta?: Record<string, unknown>\n}\n\n/**\n * Represents a Media Object entity returned by the API.\n *\n * @group API Entities\n */\nexport interface MediaObject extends StarlightEntity {\n  name: string\n  extension: string\n  mime: string\n  files: MediaFile[]\n  alt?: string\n  description?: string\n}\n\n/**\n * Represents an Author entity returned by the API.\n *\n * @group API Entities\n */\nexport interface Author {\n  id: number\n  name: string\n}\n\n/**\n * Represents a Model entity returned by the API.\n *\n * @group API Entities\n */\nexport interface Model extends StarlightEntity {\n  title: string\n  slug: string\n  entry_count?: number\n}\n\n/**\n * Represents content data returned by either an Entry or\n * Singleton entity from the API.\n */\nexport type SerializedData = Record<string, unknown> | undefined\n\n/**\n * Utility type that creates a string map of all fields of the given\n * SerializedData type with the `field` suffix. This is only useful to create\n * request methods that support field querying using the \"field:foo\" syntax.\n *\n * @internal\n */\nexport type ModelFieldOptions<D extends SerializedData> = {\n  [K in keyof D as `field:${string & K}`]?: string\n}\n\n/**\n * Represents an Entry entity returned by the API.\n *\n * An Entry's `data` field can be further typed by passing an object-like\n * structure as the D generic type. This is useful to provide type-safety to\n * your application, since the `data` field is a generic JS object by default.\n *\n * It's recommended to use the Field types provided by this SDK to type your\n * entities using a type definition file on your project. For instance:\n *\n * ```ts\n * // starlight.d.ts file\n * import { VisualField, MediaField } from '@starlightcms/js-sdk'\n *\n * type PostFields = {\n *   featured_image: MediaField\n *   content: VisualField\n * }\n *\n * declare module '@starlightcms/js-sdk' {\n *   export interface DefaultModelDefinition {\n *     posts: PostFields\n *   }\n * }\n * ```\n *\n * You can place this type definition file anywhere in your repository, but it's\n * good practice to place it at the same level as your root index.ts file. Then,\n * in your files, all SDK calls will correctly type `posts`:\n *\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // response type will be StarlightItemResponse<Entry<PostFields>> on request success\n * const response = await Starlight.posts.entries.get('hello-world')\n *\n * // helloWorld type is Entry<PostFields>\n * const helloWorld = response.data\n * ```\n *\n * See {@apilink DefaultModelDefinition} for more info.\n *\n * @group API Entities\n */\nexport interface Entry<D extends SerializedData>\n  extends Omit<StarlightEntity, 'created_at'> {\n  title: string\n  slug: string\n  data: D\n  author: Author\n  model?: Model\n  category: ModelCategory | null\n  published_at: string | null\n}\n\n/**\n * Represents a Singleton entity returned by the API.\n *\n * A Singleton's `data` field can be further typed by passing an object-like\n * structure as the D generic type. This is useful to provide type-safety to\n * your application, since the `data` field is a generic JS object by default.\n *\n * It's recommended to use the Field types provided by this SDK to type your\n * Singletons. For instance:\n *\n * ```ts\n * import { StringField, VisualField, MediaField } from '@starlightcms/js-sdk'\n *\n * type HomeFields = {\n *   site_title: StringField\n *   hero_image: MediaField\n *   hero_content: VisualField\n * }\n *\n * // response type will be StarlightItemResponse<Singleton<HomeFields>> on request success\n * const response = Starlight.singletons.get<HomeFields>('home')\n *\n * // home type is Singleton<HomeFields>\n * const home = response.data\n * ```\n *\n * You could also place all your Singleton field types in the same type\n * definition file used to configure Entry fields, which makes it easier to\n * import these types in other files on your project. See\n * {@apilink DefaultModelDefinition} for more info.\n *\n * @group API Entities\n */\nexport interface Singleton<D extends SerializedData>\n  extends Omit<StarlightEntity, 'created_at'> {\n  title: string\n  slug: string\n  data: D\n  published_at: string | null\n}\n\n/**\n * Currently supported Collection types. This type is mainly used to provide\n * autocompletion on IDEs, since it lets users use any string as well as the\n * known supported types.\n *\n * @internal\n */\nexport type CollectionTypes = 'entry' | 'singleton' | 'media' | string\n\n/**\n * Currently supported Collection entities. This type is mainly used to infer\n * the collection type string (see {@link CollectionTypes}) from the type of\n * entity that that Collection holds.\n *\n * @internal\n */\nexport type CollectionEntityTypes =\n  | Entry<never>\n  | Singleton<never>\n  | MediaObject\n  | unknown\n\n/**\n * Infers a Collection type from an entity type. See {@link CollectionTypes} and\n * {@link CollectionEntityTypes} to know more.\n *\n * @internal\n */\nexport type CollectionTypeMapper<T extends CollectionEntityTypes> =\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  T extends Entry<any>\n    ? 'entry'\n    : T extends Singleton<any> // eslint-disable-line @typescript-eslint/no-explicit-any\n    ? 'singleton'\n    : T extends MediaObject\n    ? 'media'\n    : string\n\n/**\n * Represents a Collection entity returned by the API.\n *\n * @group API Entities\n */\nexport interface Collection<T extends CollectionTypes = string>\n  extends StarlightEntity {\n  title: string\n  slug: string\n  type: T\n  item_count?: number\n}\n\n/**\n * Currently supported Relation types.\n */\ntype RelationTypes =\n  | Entry<never>\n  | Singleton<never>\n  | MediaObject\n  | Collection\n  | unknown\n\n/**\n * Represents a Relation entity returned by the API.\n *\n * @group API Entities\n */\nexport interface Relation<T extends RelationTypes> {\n  /**\n   * The relation type, which is always a string. If the `object` field of this\n   * Relation is an Entry, type will be `entry`, if it's a Singleton, type will\n   * be `singleton`, and so on.\n   */\n  type: T extends Entry<never>\n    ? 'entry'\n    : T extends Singleton<never>\n    ? 'singleton'\n    : T extends MediaObject\n    ? 'media'\n    : T extends Collection\n    ? 'collection'\n    : string\n  id: number\n  object: T\n}\n"]}

package/dist/esm/types/fields.d.ts

@@ -1,10 +1,73 @@
 import { MediaObject, Relation } from './entities';
 import { VisualData } from './visual';
+/**
+ * Represents a Boolean Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type BooleanField = boolean;
+/**
+ * Represents a HTML Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type HtmlField = string;
+/**
+ * Represents a Media Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type MediaField = MediaObject;
+/**
+ * Represents a Relation Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type RelationField<T> = Relation<T>;
+/**
+ * Represents a String Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type StringField = string;
+/**
+ * Represents a Text Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type TextField = string;
+/**
+ * Represents a Visual Field returned by the API.
+ *
+ * Field types are used to type Entry and Singleton objects when requesting
+ * them using some SDK methods. See {@apilink DefaultModelDefinition}
+ * for more info.
+ *
+ * @group Data Fields
+ */
 export declare type VisualField = VisualData;
 //# sourceMappingURL=fields.d.ts.map

package/dist/esm/types/fields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../src/types/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErC,oBAAY,YAAY,GAAG,OAAO,CAAA;AAElC,oBAAY,SAAS,GAAG,MAAM,CAAA;AAE9B,oBAAY,UAAU,GAAG,WAAW,CAAA;AAEpC,oBAAY,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA;AAE1C,oBAAY,WAAW,GAAG,MAAM,CAAA;AAEhC,oBAAY,SAAS,GAAG,MAAM,CAAA;AAE9B,oBAAY,WAAW,GAAG,UAAU,CAAA"}
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../src/types/fields.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErC;;;;;;;;GAQG;AACH,oBAAY,YAAY,GAAG,OAAO,CAAA;AAElC;;;;;;;;GAQG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAA;AAE9B;;;;;;;;GAQG;AACH,oBAAY,UAAU,GAAG,WAAW,CAAA;AAEpC;;;;;;;;GAQG;AACH,oBAAY,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA;AAE1C;;;;;;;;GAQG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAA;AAEhC;;;;;;;;GAQG;AACH,oBAAY,SAAS,GAAG,MAAM,CAAA;AAE9B;;;;;;;;GAQG;AACH,oBAAY,WAAW,GAAG,UAAU,CAAA"}

package/dist/esm/types/fields.js.map

@@ -1 +1 @@
-{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../src/types/fields.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject, Relation } from './entities'\nimport { VisualData } from './visual'\n\nexport type BooleanField = boolean\n\nexport type HtmlField = string\n\nexport type MediaField = MediaObject\n\nexport type RelationField<T> = Relation<T>\n\nexport type StringField = string\n\nexport type TextField = string\n\nexport type VisualField = VisualData\n"]}
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../../../src/types/fields.ts"],"names":[],"mappings":"","sourcesContent":["import { MediaObject, Relation } from './entities'\nimport { VisualData } from './visual'\n\n/**\n * Represents a Boolean Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type BooleanField = boolean\n\n/**\n * Represents a HTML Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type HtmlField = string\n\n/**\n * Represents a Media Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type MediaField = MediaObject\n\n/**\n * Represents a Relation Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type RelationField<T> = Relation<T>\n\n/**\n * Represents a String Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type StringField = string\n\n/**\n * Represents a Text Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type TextField = string\n\n/**\n * Represents a Visual Field returned by the API.\n *\n * Field types are used to type Entry and Singleton objects when requesting\n * them using some SDK methods. See {@apilink DefaultModelDefinition}\n * for more info.\n *\n * @group Data Fields\n */\nexport type VisualField = VisualData\n"]}