@starlightcms/js-sdk 4.0.0-beta.2 → 4.0.0-beta.3

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

@@ -1,64 +0,0 @@
-import { BaseRequestParameters, SerializedData, Singleton, StarlightItemResponse, StarlightListResponse } from '../../types';
-/**
- * A Selector that provide methods to list and request information on
- * {@apilink Singleton | Singletons}.
- *
- * You can use an SingletonSelector by accessing
- * {@apilink ModelInstance.singletons}.
- *
- * @group Selectors
- */
-export interface SingletonSelector {
-    /**
-     * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.
-     * This methods supports typing the returned Singleton by passing its data
-     * type as the generic type `<D>`.
-     *
-     * @example Requesting information from a singleton of slug "home".
-     * ```ts
-     * import Starlight from '@starlightcms/js-sdk'
-     *
-     * const response = await Starlight.singletons.get('home')
-     * ```
-     *
-     * @example Typing last example's response.
-     * ```ts
-     * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'
-     *
-     * type HomeFields = {
-     *   title: StringField
-     *   subtitle: StringField
-     *   hero_image: MediaField
-     *   hero_content: VisualField
-     * }
-     *
-     * // `response.data` will be of type Singleton<HomeFields>
-     * const response = await Starlight.singletons.get<HomeFields>('home')
-     * ```
-     * @typeParam D - The type of the returned Singleton's `data` property.
-     * @param slug The singleton slug.
-     * @param params An optional object of request parameters.
-     * @param options An optional object of fetch options. See
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
-     * more info.
-     */
-    get<D extends SerializedData>(slug: string, params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightItemResponse<Singleton<D>>>;
-    /**
-     * Returns a {@link StarlightListResponse} with a list of
-     * {@apilink Singleton | Singletons}.
-     *
-     * @example Requesting all workspace singletons.
-     * ```ts
-     * import Starlight from '@starlightcms/js-sdk'
-     *
-     * const response = await Starlight.singletons.list()
-     * ```
-     *
-     * @param params An optional object of request parameters.
-     * @param options An optional object of fetch options. See
-     * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for
-     * more info.
-     */
-    list(params?: BaseRequestParameters, options?: RequestInit): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/esm/selectors/Singleton/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,cAAc,EACd,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,GAAG,CAAC,CAAC,SAAS,cAAc,EAC1B,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/C;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACF,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAA;CACtE"}

package/dist/esm/selectors/Singleton/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/selectors/Singleton/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  SerializedData,\n  Singleton,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Singleton | Singletons}.\n *\n * You can use an SingletonSelector by accessing\n * {@apilink ModelInstance.singletons}.\n *\n * @group Selectors\n */\nexport interface SingletonSelector {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Singleton}.\n   * This methods supports typing the returned Singleton by passing its data\n   * type as the generic type `<D>`.\n   *\n   * @example Requesting information from a singleton of slug \"home\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.singletons.get('home')\n   * ```\n   *\n   * @example Typing last example's response.\n   * ```ts\n   * import Starlight, { StringField, MediaField, VisualField } from '@starlightcms/js-sdk'\n   *\n   * type HomeFields = {\n   *   title: StringField\n   *   subtitle: StringField\n   *   hero_image: MediaField\n   *   hero_content: VisualField\n   * }\n   *\n   * // `response.data` will be of type Singleton<HomeFields>\n   * const response = await Starlight.singletons.get<HomeFields>('home')\n   * ```\n   * @typeParam D - The type of the returned Singleton's `data` property.\n   * @param slug The singleton slug.\n   * @param params An optional object of request parameters.\n   * @param options An optional object of fetch options. See\n   * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n   * more info.\n   */\n  get<D extends SerializedData>(\n    slug: string,\n    params?: BaseRequestParameters,\n    options?: RequestInit,\n  ): Promise<StarlightItemResponse<Singleton<D>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Singleton | Singletons}.\n   *\n   * @example Requesting all workspace singletons.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.singletons.list()\n   * ```\n   *\n   * @param params An optional object of request parameters.\n   * @param options An optional object of fetch options. See\n   * {@link https://developer.mozilla.org/en-US/docs/Web/API/RequestInit} for\n   * more info.\n   */\n  list(\n    params?: BaseRequestParameters,\n    options?: RequestInit,\n  ): Promise<StarlightListResponse<Singleton<Record<string, unknown>>>>\n}\n"]}

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

@@ -1,362 +0,0 @@
-/**
- * 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;
-    mime: string;
-    background_color?: string;
-    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;
-    mime: string;
-    files: MediaFile[];
-    alt?: string;
-    description?: string;
-}
-/**
- * Represents an Author entity returned by the API. Authors are returned in
- * {@link Entry} requests.
- *
- * @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 a field returned by the API in Model schemas.
- *
- * @group API Entities
- */
-export interface Field {
-    title: string;
-    key: string;
-    type: string;
-    is_required: boolean;
-    is_listable: boolean;
-    is_private: boolean;
-    is_archived: boolean;
-    rules?: {
-        [rule: string]: unknown;
-    };
-}
-/**
- * Represents a group of fields returned by the API in Model schemas.
- *
- * @group API Entities
- */
-export interface SchemaFieldGroup {
-    title: string;
-    type: string;
-    fields: Field[];
-}
-/**
- * Represents a Model schema entity returned by the API.
- *
- * @group API Entities
- */
-export interface ModelSchema {
-    version: number;
-    groups: SchemaFieldGroup[];
-}
-/**
- * Represents a Form entity returned by the API.
- *
- * @group API Entities
- */
-export interface Form extends StarlightEntity {
-    title: string;
-    slug: string;
-    action_url: string;
-}
-/**
- * Represents a Form schema entity returned by the API.
- *
- * @group API Entities
- */
-export interface FormSchema extends ModelSchema {
-    action_url: string;
-}
-/**
- * Represents content data returned by either an {@link Entry} or
- * {@link Singleton} entity from the API.
- *
- * This is a utility type used internally by the SDK and you don't
- * need to use it. Its purpose is to constraint Entry and Singleton
- * data to the shape of a JS object.
- *
- * @category Internal Types
- */
-export type SerializedData = Record<string, unknown> | undefined;
-/**
- * Utility type that creates a string map of all fields of the given
- * SerializedData type with the `field:` prefix. This syntax allows to filter
- * specific fields when listing {@apilink Entry | Entries}:
- *
- * - Text fields can be filtered by a string query. This works just like
- *   passing a `query` parameter, but it only applies to one field.
- * - Boolean fields can be filtered by "true" or "false".
- *
- * If a request uses this type, it means that this syntax can be used in their
- * parameters:
- *
- * ```ts
- * import Starlight from '@starlightcms/js-sdk'
- *
- * const response = await Starlight.posts.entries.list({
- *   // EntrySelector.list() supports the "field:foo" syntax:
- *   'field:content': 'hello world',
- *   'field:is_featured': true,
- *
- *   // EntrySelector.list() also support other parameters,
- *   // which are passed in this object too:
- *   page: 42,
- *   limit: 20,
- * })
- * ```
- *
- * @remark
- *
- * The information below is only useful for SDK maintainers.
- *
- * This type receives a {@link SerializedData}-like structure, like an object.
- * For instance, for an {@link Entry} with fields "content" and "summary",
- * the generated type would look like this:
- *
- * ```ts
- * type GeneratedType = {
- *   'field:content'?: string
- *   'field:summary'?: string
- * }
- * ```
- *
- * However, note that QueryableFields receive a {@link SerializedData}, not an
- * {@link Entry}:
- *
- * ```ts
- * import { VisualField, StringField } from '@starlightcms/js-sdk'
- *
- * type EntryFields = {
- *   content: VisualField
- *   summary: StringField
- * }
- *
- * type MyEntry = Entry<EntryFields>
- *
- * // Error TS2344: Type does not satisfy the constraint 'SerializedData'
- * type GeneratedType = QueryableFields<MyEntry>
- *
- * // Works!
- * type GeneratedType = QueryableFields<EntryFields>
- * ```
- *
- * This type is only useful to request methods that support
- * field querying using the "field:foo" syntax.
- *
- * @category Internal Types
- */
-export type QueryableFields<D extends SerializedData> = {
-    [K in keyof D as `field:${string & K}`]?: string | boolean;
-};
-/**
- * Utility type that return {@link QueryableFields} if the given type T
- * is an {@link Entry} or a {@link Singleton}, but generates an empty object
- * otherwise.
- *
- * Fun fact: internally, Entries and Singletons have parent Models,
- * which is why they are called "modelables" here.
- *
- * @category Internal Types
- */
-export type WithQueryableFieldsOnModelables<T> = T extends Entry<never> | Singleton<never> ? QueryableFields<T['data']> : never;
-/**
- * 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;
-    data: D;
-    author: Author;
-    model?: Model;
-    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 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 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 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.
- *
- * You can request collections using a {@link CollectionInstance} or a
- * {@link CollectionSelector}.
- *
- * @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.
- */
-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;
-}
-export {};
-//# sourceMappingURL=entities.d.ts.map

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

@@ -1 +0,0 @@
-{"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;;;;;GAKG;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;;;;GAIG;AACH,MAAM,WAAW,KAAK;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,OAAO,CAAA;IACpB,WAAW,EAAE,OAAO,CAAA;IACpB,UAAU,EAAE,OAAO,CAAA;IACnB,WAAW,EAAE,OAAO,CAAA;IACpB,KAAK,CAAC,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KACxB,CAAA;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,gBAAgB,EAAE,CAAA;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAK,SAAQ,eAAe;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC7C,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,cAAc,IAAI;KACrD,CAAC,IAAI,MAAM,CAAC,IAAI,SAAS,MAAM,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO;CAC3D,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,+BAA+B,CAAC,CAAC,IAAI,CAAC,SAC9C,KAAK,CAAC,KAAK,CAAC,GACZ,SAAS,CAAC,KAAK,CAAC,GAChB,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAC1B,KAAK,CAAA;AAET;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,cAAc,CAAE,SAAQ,IAAI,CAC3D,eAAe,EACf,YAAY,CACb;IACC,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,CAAE,SAAQ,IAAI,CAC/D,eAAe,EACf,YAAY,CACb;IACC,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,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAA;AAEtE;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,CAAC,KAAK,CAAC,GACZ,SAAS,CAAC,KAAK,CAAC,GAChB,WAAW,GACX,OAAO,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,qBAAqB,IAE9D,CAAC,SAAS,KAAK,CAAC,GAAG,CAAC,GAChB,OAAO,GACP,CAAC,SAAS,SAAS,CAAC,GAAG,CAAC,GACtB,WAAW,GACX,CAAC,SAAS,WAAW,GACnB,OAAO,GACP,MAAM,CAAA;AAEhB;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU,CACzB,CAAC,SAAS,eAAe,GAAG,MAAM,CAClC,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,KAAK,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,GACxB,WAAW,GACX,CAAC,SAAS,WAAW,GACnB,OAAO,GACP,CAAC,SAAS,UAAU,GAClB,YAAY,GACZ,MAAM,CAAA;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,CAAC,CAAA;CACV"}

package/dist/esm/types/entities.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=entities.js.map

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

@@ -1 +0,0 @@
-{"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. Authors are returned in\n * {@link Entry} requests.\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 a field returned by the API in Model schemas.\n *\n * @group API Entities\n */\nexport interface Field {\n  title: string\n  key: string\n  type: string\n  is_required: boolean\n  is_listable: boolean\n  is_private: boolean\n  is_archived: boolean\n  rules?: {\n    [rule: string]: unknown\n  }\n}\n\n/**\n * Represents a group of fields returned by the API in Model schemas.\n *\n * @group API Entities\n */\nexport interface SchemaFieldGroup {\n  title: string\n  type: string\n  fields: Field[]\n}\n\n/**\n * Represents a Model schema entity returned by the API.\n *\n * @group API Entities\n */\nexport interface ModelSchema {\n  version: number\n  groups: SchemaFieldGroup[]\n}\n\n/**\n * Represents a Form entity returned by the API.\n *\n * @group API Entities\n */\nexport interface Form extends StarlightEntity {\n  title: string\n  slug: string\n  action_url: string\n}\n\n/**\n * Represents a Form schema entity returned by the API.\n *\n * @group API Entities\n */\nexport interface FormSchema extends ModelSchema {\n  action_url: string\n}\n\n/**\n * Represents content data returned by either an {@link Entry} or\n * {@link Singleton} entity from the API.\n *\n * This is a utility type used internally by the SDK and you don't\n * need to use it. Its purpose is to constraint Entry and Singleton\n * data to the shape of a JS object.\n *\n * @category Internal Types\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:` prefix. This syntax allows to filter\n * specific fields when listing {@apilink Entry | Entries}:\n *\n * - Text fields can be filtered by a string query. This works just like\n *   passing a `query` parameter, but it only applies to one field.\n * - Boolean fields can be filtered by \"true\" or \"false\".\n *\n * If a request uses this type, it means that this syntax can be used in their\n * parameters:\n *\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.list({\n *   // EntrySelector.list() supports the \"field:foo\" syntax:\n *   'field:content': 'hello world',\n *   'field:is_featured': true,\n *\n *   // EntrySelector.list() also support other parameters,\n *   // which are passed in this object too:\n *   page: 42,\n *   limit: 20,\n * })\n * ```\n *\n * @remark\n *\n * The information below is only useful for SDK maintainers.\n *\n * This type receives a {@link SerializedData}-like structure, like an object.\n * For instance, for an {@link Entry} with fields \"content\" and \"summary\",\n * the generated type would look like this:\n *\n * ```ts\n * type GeneratedType = {\n *   'field:content'?: string\n *   'field:summary'?: string\n * }\n * ```\n *\n * However, note that QueryableFields receive a {@link SerializedData}, not an\n * {@link Entry}:\n *\n * ```ts\n * import { VisualField, StringField } from '@starlightcms/js-sdk'\n *\n * type EntryFields = {\n *   content: VisualField\n *   summary: StringField\n * }\n *\n * type MyEntry = Entry<EntryFields>\n *\n * // Error TS2344: Type does not satisfy the constraint 'SerializedData'\n * type GeneratedType = QueryableFields<MyEntry>\n *\n * // Works!\n * type GeneratedType = QueryableFields<EntryFields>\n * ```\n *\n * This type is only useful to request methods that support\n * field querying using the \"field:foo\" syntax.\n *\n * @category Internal Types\n */\nexport type QueryableFields<D extends SerializedData> = {\n  [K in keyof D as `field:${string & K}`]?: string | boolean\n}\n\n/**\n * Utility type that return {@link QueryableFields} if the given type T\n * is an {@link Entry} or a {@link Singleton}, but generates an empty object\n * otherwise.\n *\n * Fun fact: internally, Entries and Singletons have parent Models,\n * which is why they are called \"modelables\" here.\n *\n * @category Internal Types\n */\nexport type WithQueryableFieldsOnModelables<T> = T extends\n  | Entry<never>\n  | Singleton<never>\n  ? QueryableFields<T['data']>\n  : never\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> extends Omit<\n  StarlightEntity,\n  'created_at'\n> {\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> extends Omit<\n  StarlightEntity,\n  'created_at'\n> {\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 * You can request collections using a {@link CollectionInstance} or a\n * {@link CollectionSelector}.\n *\n * @group API Entities\n */\nexport interface Collection<\n  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,123 +0,0 @@
-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 type BooleanField = boolean | undefined;
-/**
- * Represents an 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 type HtmlField = string | undefined;
-/**
- * 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 type MediaField = MediaObject | undefined;
-/**
- * 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 type RelationField<T> = Relation<T> | undefined;
-/**
- * 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 type StringField = string | undefined;
-/**
- * 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 type TextField = string | undefined;
-/**
- * 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 type VisualField = VisualData | undefined;
-/**
- * Represents an Integer 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 type IntegerField = number | undefined;
-/**
- * Represents a Float 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 type FloatField = number | undefined;
-/**
- * Represents a Decimal 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 type DecimalField = number | undefined;
-export type SelectFieldOptions = {
-    /**
-     * Indicates if the Select Field accepts multiple selected choices.
-     *
-     * @default false
-     */
-    multiple?: boolean;
-};
-/**
- * Represents a Select 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 type SelectField<Options extends SelectFieldOptions = {
-    multiple: false;
-}> = (Options['multiple'] extends false ? string : string | string[]) | undefined;
-//# sourceMappingURL=fields.d.ts.map

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

@@ -1 +0,0 @@
-{"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,MAAM,MAAM,YAAY,GAAG,OAAO,GAAG,SAAS,CAAA;AAE9C;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;AAE1C;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,WAAW,GAAG,SAAS,CAAA;AAEhD;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,SAAS,CAAA;AAEtD;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAA;AAE5C;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,SAAS,CAAA;AAE1C;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,GAAG,SAAS,CAAA;AAEhD;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE7C;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,SAAS,CAAA;AAE3C;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;AAE7C,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,CACrB,OAAO,SAAS,kBAAkB,GAAG;IAAE,QAAQ,EAAE,KAAK,CAAA;CAAE,IACtD,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,SAAS,CAAA"}

package/dist/esm/types/fields.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=fields.js.map

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

@@ -1 +0,0 @@
-{"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 | undefined\n\n/**\n * Represents an 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 | undefined\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 | undefined\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> | undefined\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 | undefined\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 | undefined\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 | undefined\n\n/**\n * Represents an Integer 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 IntegerField = number | undefined\n\n/**\n * Represents a Float 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 FloatField = number | undefined\n\n/**\n * Represents a Decimal 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 DecimalField = number | undefined\n\nexport type SelectFieldOptions = {\n  /**\n   * Indicates if the Select Field accepts multiple selected choices.\n   *\n   * @default false\n   */\n  multiple?: boolean\n}\n\n/**\n * Represents a Select 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 SelectField<\n  Options extends SelectFieldOptions = { multiple: false },\n> = (Options['multiple'] extends false ? string : string | string[]) | undefined\n"]}

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

@@ -1,30 +0,0 @@
-/**
- * Represents a Group returned by the API.
- *
- * Group types are used to type Entry and Singleton objects when requesting
- * them using some SDK methods. See {@apilink DefaultModelDefinition}
- * for more info.
- *
- * @group Data Groups
- */
-export type Group<Fields extends Record<string, unknown>> = {
-    [Property in keyof Fields]: Fields[Property];
-} | undefined;
-/**
- * Represents a Repeater Group returned by the API.
- *
- * Note that the API return empty repeaters as `null`.
- *
- * To retrieve the type of a `RepeaterGroup` item, use the
- * {@apilink RepeaterItem} utility type.
- *
- * Group types are used to type Entry and Singleton objects when requesting
- * them using some SDK methods. See {@apilink DefaultModelDefinition}
- * for more info.
- *
- * @group Data Groups
- */
-export type RepeaterGroup<Fields extends Record<string, unknown>> = Array<{
-    [Property in keyof Fields]: Fields[Property];
-}> | null | undefined;
-//# sourceMappingURL=groups.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"groups.d.ts","sourceRoot":"","sources":["../../../src/types/groups.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,KAAK,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpD;KAAG,QAAQ,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC;CAAE,GAChD,SAAS,CAAA;AAEb;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,aAAa,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC5D,KAAK,CAAC;KAAG,QAAQ,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC;CAAE,CAAC,GACvD,IAAI,GACJ,SAAS,CAAA"}

package/dist/esm/types/groups.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=groups.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"groups.js","sourceRoot":"","sources":["../../../src/types/groups.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * Represents a Group returned by the API.\n *\n * Group 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 Groups\n */\nexport type Group<Fields extends Record<string, unknown>> =\n  | { [Property in keyof Fields]: Fields[Property] }\n  | undefined\n\n/**\n * Represents a Repeater Group returned by the API.\n *\n * Note that the API return empty repeaters as `null`.\n *\n * To retrieve the type of a `RepeaterGroup` item, use the\n * {@apilink RepeaterItem} utility type.\n *\n * Group 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 Groups\n */\nexport type RepeaterGroup<Fields extends Record<string, unknown>> =\n  | Array<{ [Property in keyof Fields]: Fields[Property] }>\n  | null\n  | undefined\n"]}