@starlightcms/js-sdk 0.11.0 → 0.13.0

package/dist/cjs/mocks/fixtures/index.d.ts

@@ -0,0 +1,2 @@
+export * from './modelsList';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/mocks/fixtures/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../mocks/fixtures/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA"}

package/dist/cjs/mocks/fixtures/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./modelsList"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/mocks/fixtures/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../mocks/fixtures/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B","sourcesContent":["export * from './modelsList'\n"]}

package/dist/cjs/mocks/fixtures/modelsList.d.ts

@@ -0,0 +1,35 @@
+export declare const modelsListMock: {
+    data: {
+        id: number;
+        title: string;
+        slug: string;
+        entry_count: number;
+        created_at: string;
+        updated_at: string;
+    }[];
+    links: {
+        first: string;
+        last: string;
+        prev: null;
+        next: null;
+    };
+    meta: {
+        current_page: number;
+        from: number;
+        last_page: number;
+        links: ({
+            url: null;
+            label: string;
+            active: boolean;
+        } | {
+            url: string;
+            label: string;
+            active: boolean;
+        })[];
+        path: string;
+        per_page: number;
+        to: number;
+        total: number;
+    };
+};
+//# sourceMappingURL=modelsList.d.ts.map

package/dist/cjs/mocks/fixtures/modelsList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsList.d.ts","sourceRoot":"","sources":["../../../../mocks/fixtures/modelsList.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAmH1B,CAAA"}

package/dist/cjs/mocks/fixtures/modelsList.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.modelsListMock = void 0;
+exports.modelsListMock = {
+    data: [
+        {
+            id: 1293995972,
+            title: 'Posts',
+            slug: 'posts',
+            entry_count: 294,
+            created_at: '2020-05-07T14:55:18.000000Z',
+            updated_at: '2022-08-10T16:49:29.000000Z',
+        },
+        {
+            id: 600356069,
+            title: 'Revistas',
+            slug: 'magazines',
+            entry_count: 36,
+            created_at: '2020-05-07T15:00:56.000000Z',
+            updated_at: '2020-05-12T17:48:43.000000Z',
+        },
+        {
+            id: 2121937896,
+            title: 'Produtos',
+            slug: 'products',
+            entry_count: 11,
+            created_at: '2020-05-11T15:25:11.000000Z',
+            updated_at: '2020-05-11T15:25:11.000000Z',
+        },
+        {
+            id: 707331498,
+            title: 'Quadros',
+            slug: 'videos',
+            entry_count: 4523,
+            created_at: '2020-05-14T16:57:36.000000Z',
+            updated_at: '2020-05-14T16:57:36.000000Z',
+        },
+        {
+            id: 1230830781,
+            title: 'Programas',
+            slug: 'shows',
+            entry_count: 604,
+            created_at: '2020-05-14T17:01:16.000000Z',
+            updated_at: '2020-05-14T17:01:16.000000Z',
+        },
+        {
+            id: 1703836224,
+            title: 'Artigos de Destaque',
+            slug: 'magazine-articles',
+            entry_count: 2,
+            created_at: '2020-05-15T14:48:49.000000Z',
+            updated_at: '2020-05-15T14:48:49.000000Z',
+        },
+        {
+            id: 317193827,
+            title: 'Posts - Mais Parceiros',
+            slug: 'posts-mais-parceiros',
+            entry_count: 2,
+            created_at: '2021-06-18T20:03:26.000000Z',
+            updated_at: '2021-06-18T20:03:26.000000Z',
+        },
+        {
+            id: 2123812909,
+            title: 'Ebooks',
+            slug: 'ebooks',
+            entry_count: 3,
+            created_at: '2021-07-12T11:45:43.000000Z',
+            updated_at: '2021-07-12T11:45:43.000000Z',
+        },
+        {
+            id: 1681528965,
+            title: 'Teste',
+            slug: 'teste',
+            entry_count: 0,
+            created_at: '2021-07-18T21:23:21.000000Z',
+            updated_at: '2022-07-03T22:59:15.000000Z',
+        },
+        {
+            id: 1616301182,
+            title: 'Panfletos',
+            slug: 'panfletos',
+            entry_count: 1,
+            created_at: '2021-08-19T20:20:40.000000Z',
+            updated_at: '2021-08-19T20:20:40.000000Z',
+        },
+    ],
+    links: {
+        first: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',
+        last: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',
+        prev: null,
+        next: null,
+    },
+    meta: {
+        current_page: 1,
+        from: 1,
+        last_page: 1,
+        links: [
+            {
+                url: null,
+                label: '« Previous',
+                active: false,
+            },
+            {
+                url: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',
+                label: '1',
+                active: true,
+            },
+            {
+                url: null,
+                label: 'Next »',
+                active: false,
+            },
+        ],
+        path: 'https://query.starlight.sh/v2/workspaces/327329647/models',
+        per_page: 15,
+        to: 11,
+        total: 11,
+    },
+};
+//# sourceMappingURL=modelsList.js.map

package/dist/cjs/mocks/fixtures/modelsList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsList.js","sourceRoot":"","sources":["../../../../mocks/fixtures/modelsList.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC5B,IAAI,EAAE;QACJ;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,GAAG;YAChB,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,UAAU;YACjB,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,GAAG;YAChB,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,mBAAmB;YACzB,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,SAAS;YACb,KAAK,EAAE,wBAAwB;YAC/B,IAAI,EAAE,sBAAsB;YAC5B,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,OAAO;YACd,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;QACD;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,6BAA6B;YACzC,UAAU,EAAE,6BAA6B;SAC1C;KACF;IACD,KAAK,EAAE;QACL,KAAK,EAAE,kEAAkE;QACzE,IAAI,EAAE,kEAAkE;QACxE,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;KACX;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,CAAC;QACf,IAAI,EAAE,CAAC;QACP,SAAS,EAAE,CAAC;QACZ,KAAK,EAAE;YACL;gBACE,GAAG,EAAE,IAAI;gBACT,KAAK,EAAE,kBAAkB;gBACzB,MAAM,EAAE,KAAK;aACd;YACD;gBACE,GAAG,EAAE,kEAAkE;gBACvE,KAAK,EAAE,GAAG;gBACV,MAAM,EAAE,IAAI;aACb;YACD;gBACE,GAAG,EAAE,IAAI;gBACT,KAAK,EAAE,cAAc;gBACrB,MAAM,EAAE,KAAK;aACd;SACF;QACD,IAAI,EAAE,2DAA2D;QACjE,QAAQ,EAAE,EAAE;QACZ,EAAE,EAAE,EAAE;QACN,KAAK,EAAE,EAAE;KACV;CACF,CAAA","sourcesContent":["export const modelsListMock = {\n  data: [\n    {\n      id: 1293995972,\n      title: 'Posts',\n      slug: 'posts',\n      entry_count: 294,\n      created_at: '2020-05-07T14:55:18.000000Z',\n      updated_at: '2022-08-10T16:49:29.000000Z',\n    },\n    {\n      id: 600356069,\n      title: 'Revistas',\n      slug: 'magazines',\n      entry_count: 36,\n      created_at: '2020-05-07T15:00:56.000000Z',\n      updated_at: '2020-05-12T17:48:43.000000Z',\n    },\n    {\n      id: 2121937896,\n      title: 'Produtos',\n      slug: 'products',\n      entry_count: 11,\n      created_at: '2020-05-11T15:25:11.000000Z',\n      updated_at: '2020-05-11T15:25:11.000000Z',\n    },\n    {\n      id: 707331498,\n      title: 'Quadros',\n      slug: 'videos',\n      entry_count: 4523,\n      created_at: '2020-05-14T16:57:36.000000Z',\n      updated_at: '2020-05-14T16:57:36.000000Z',\n    },\n    {\n      id: 1230830781,\n      title: 'Programas',\n      slug: 'shows',\n      entry_count: 604,\n      created_at: '2020-05-14T17:01:16.000000Z',\n      updated_at: '2020-05-14T17:01:16.000000Z',\n    },\n    {\n      id: 1703836224,\n      title: 'Artigos de Destaque',\n      slug: 'magazine-articles',\n      entry_count: 2,\n      created_at: '2020-05-15T14:48:49.000000Z',\n      updated_at: '2020-05-15T14:48:49.000000Z',\n    },\n    {\n      id: 317193827,\n      title: 'Posts - Mais Parceiros',\n      slug: 'posts-mais-parceiros',\n      entry_count: 2,\n      created_at: '2021-06-18T20:03:26.000000Z',\n      updated_at: '2021-06-18T20:03:26.000000Z',\n    },\n    {\n      id: 2123812909,\n      title: 'Ebooks',\n      slug: 'ebooks',\n      entry_count: 3,\n      created_at: '2021-07-12T11:45:43.000000Z',\n      updated_at: '2021-07-12T11:45:43.000000Z',\n    },\n    {\n      id: 1681528965,\n      title: 'Teste',\n      slug: 'teste',\n      entry_count: 0,\n      created_at: '2021-07-18T21:23:21.000000Z',\n      updated_at: '2022-07-03T22:59:15.000000Z',\n    },\n    {\n      id: 1616301182,\n      title: 'Panfletos',\n      slug: 'panfletos',\n      entry_count: 1,\n      created_at: '2021-08-19T20:20:40.000000Z',\n      updated_at: '2021-08-19T20:20:40.000000Z',\n    },\n  ],\n  links: {\n    first: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',\n    last: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',\n    prev: null,\n    next: null,\n  },\n  meta: {\n    current_page: 1,\n    from: 1,\n    last_page: 1,\n    links: [\n      {\n        url: null,\n        label: '« Previous',\n        active: false,\n      },\n      {\n        url: 'https://query.starlight.sh/v2/workspaces/327329647/models?page=1',\n        label: '1',\n        active: true,\n      },\n      {\n        url: null,\n        label: 'Next »',\n        active: false,\n      },\n    ],\n    path: 'https://query.starlight.sh/v2/workspaces/327329647/models',\n    per_page: 15,\n    to: 11,\n    total: 11,\n  },\n}\n"]}

package/dist/cjs/{client.d.ts → src/client.d.ts}

@@ -38,5 +38,5 @@ import { DefaultModelDefinition, DynamicStarlightClient, StarlightConfig, Worksp
  * available options.
  * @group Client
  */
-export declare function makeClient<D extends WorkspaceModelDefinition = DefaultModelDefinition>(config?: StarlightConfig): DynamicStarlightClient<D>;
+export declare function makeClient<D extends WorkspaceModelDefinition = DefaultModelDefinition>(config?: StarlightConfig): DynamicStarlightClient<D & WorkspaceModelDefinition>;
 //# sourceMappingURL=client.d.ts.map

package/dist/cjs/src/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EAEtB,eAAe,EACf,wBAAwB,EACzB,MAAM,SAAS,CAAA;AAUhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,UAAU,CACxB,CAAC,SAAS,wBAAwB,GAAG,sBAAsB,EAE3D,MAAM,GAAE,eAAoB,GAC3B,sBAAsB,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAwFtD"}

package/dist/cjs/{client.js → src/client.js}

@@ -77,6 +77,9 @@ function makeClient(config = {}) {
                 console.log(message, ...optionalParams);
         },
         getBaseUrl() {
+            if (!workspace.length) {
+                throw new Error('No workspace defined. Use the `configure()` method on the Starlight client to define one.');
+            }
             return `${baseUrl}/workspaces/${workspace}`;
         },
         get(path, params = {}, options) {

package/dist/cjs/src/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,qCAAyC;AACzC,8DAAiD;AACjD,8DAAiD;AACjD,sEAAyD;AACzD,wEAA2D;AAC3D,8DAAiD;AACjD,gEAAmD;AACnD,wEAA2D;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,SAAgB,UAAU,CAGxB,SAA0B,EAAE;;IAE5B,IAAI,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,+BAA+B,CAAA;IAC/D,IAAI,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,EAAE,CAAA;IACtC,IAAI,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;IAEjC,MAAM,MAAM,GAAoB;QAC9B,SAAS,CAAC,MAAM;;YACd,OAAO,GAAG,MAAA,MAAM,CAAC,OAAO,mCAAI,OAAO,CAAA;YACnC,SAAS,GAAG,MAAA,MAAM,CAAC,SAAS,mCAAI,SAAS,CAAA;YACzC,KAAK,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,KAAK,CAAA;QAC/B,CAAC;QAED,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc;YAC5B,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACpD,CAAC;QAED,UAAU;YACR,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE;gBACrB,MAAM,IAAI,KAAK,CACb,2FAA2F,CAC5F,CAAA;aACF;YAED,OAAO,GAAG,OAAO,eAAe,SAAS,EAAE,CAAA;QAC7C,CAAC;QAEK,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,EAAE,EAAE,OAAO;;gBAClC,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,GAAG,EAAE,EAAE;oBACrE,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;oBAEzB,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK;wBAAE,WAAW,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;oBAE9D,OAAO,WAAW,CAAA;gBACpB,CAAC,EAAE,EAA4B,CAAC,CAAA;gBAEhC,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAA;gBACnE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,IAAI,CAAA;gBAEjE,IAAI,CAAC,GAAG,CAAC,mBAAmB,SAAS,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC,CAAA;gBAEzE,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;oBACnD,OAAO,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;iBAC7B;qBAAM;oBACL,MAAM,OAAO,GAAG,mBAAmB,IAAI,aAAa,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAA;oBAC7F,MAAM,IAAI,uBAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;iBAC5C;YACH,CAAC;SAAA;QAED,IAAI,MAAM;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,KAAK,CAAC,IAAI;YACR,OAAO,IAAA,eAAiB,EAAC,IAAI,EAAE,IAAc,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,mBAAqB,EAAC,IAAI,CAAC,CAAA;QACpC,CAAC;QAED,IAAI,WAAW;YACb,OAAO,IAAA,oBAAsB,EAAC,IAAI,CAAC,CAAA;QACrC,CAAC;QAED,UAAU,CAAC,IAAqB;YAC9B,OAAO,IAAA,oBAAsB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC3C,CAAC;QAED,IAAI,KAAK;YACP,OAAO,IAAA,eAAiB,EAAC,IAAI,CAAC,CAAA;QAChC,CAAC;QAED,IAAI,MAAM;YACR,OAAO,IAAA,gBAAkB,EAAC,IAAI,CAAC,CAAA;QACjC,CAAC;KACF,CAAA;IAED,OAAO,IAAI,KAAK,CAAC,MAAM,EAAE;QACvB,GAAG,CAAC,MAAM,EAAE,IAAI;YACd,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;gBAC1D,OAAO,IAAA,eAAiB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aACvC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAAyD,CAAA;AAC5D,CAAC;AA5FD,gCA4FC","sourcesContent":["import {\n  DefaultModelDefinition,\n  DynamicStarlightClient,\n  StarlightClient,\n  StarlightConfig,\n  WorkspaceModelDefinition,\n} from './types'\nimport { StarlightError } from './errors'\nimport makeModelSelector from './selectors/Model'\nimport makeModelInstance from './instances/Model'\nimport makeSingletonSelector from './selectors/Singleton'\nimport makeCollectionSelector from './selectors/Collection'\nimport makeMediaSelector from './selectors/Media'\nimport makeSearchSelector from './selectors/Search'\nimport makeCollectionInstance from './instances/Collection'\n\n/**\n * Returns a new {@link DynamicStarlightClient}, which is a\n * {@link StarlightClient} with support to create\n * {@apilink ModelInstance | ModelInstances} using the dynamic syntax. To learn\n * which methods a client supports, see {@link StarlightClient}.\n *\n * This function accepts a {@link StarlightConfig} object and can be used to\n * create new clients that connect to a single Starlight workspace. Each client\n * returned by this function is separate and independent of the others.\n *\n * If you only need to make requests to a single workspace, it's probably easier\n * to use the SDK's default client. To use it, you only need to\n * import the default object exported by the SDK:\n *\n *  ```ts\n * // `Starlight` below is the default StarlightClient.\n * import Starlight from '@starlightcms/js-sdk'\n * ```\n *\n * See {@link default} for more info on how to use the default client.\n *\n * @example Creating a new client and exporting it.\n *  ```ts\n * import { makeStarlightClient } from '@starlightcms/js-sdk'\n *\n * const BlogClient = makeStarlightClient({\n *   workspace: '123123123',\n *   debug: true\n * })\n *\n * // Feel free to export the new client so your application can use it.\n * export default BlogClient\n * ```\n *\n * @param config The client configuration object. You need to provide at least\n * the `workspace` property. See {@link StarlightConfig} to view all the\n * available options.\n * @group Client\n */\nexport function makeClient<\n  D extends WorkspaceModelDefinition = DefaultModelDefinition\n>(\n  config: StarlightConfig = {}\n): DynamicStarlightClient<D & WorkspaceModelDefinition> {\n  let baseUrl = config.baseUrl ?? 'https://query.starlight.sh/v2'\n  let workspace = config.workspace ?? ''\n  let debug = config.debug ?? false\n\n  const client: StarlightClient = {\n    configure(config) {\n      baseUrl = config.baseUrl ?? baseUrl\n      workspace = config.workspace ?? workspace\n      debug = config.debug ?? debug\n    },\n\n    log(message, ...optionalParams) {\n      if (debug) console.log(message, ...optionalParams)\n    },\n\n    getBaseUrl() {\n      if (!workspace.length) {\n        throw new Error(\n          'No workspace defined. Use the `configure()` method on the Starlight client to define one.'\n        )\n      }\n\n      return `${baseUrl}/workspaces/${workspace}`\n    },\n\n    async get(path, params = {}, options) {\n      const filteredParams = Object.keys(params).reduce((accumulator, key) => {\n        const param = params[key]\n\n        if (param || param === false) accumulator[key] = String(param)\n\n        return accumulator\n      }, {} as Record<string, string>)\n\n      const searchParams = new URLSearchParams(filteredParams).toString()\n      const finalPath = searchParams ? `${path}?${searchParams}` : path\n\n      this.log(`Starlight - GET ${finalPath}`)\n\n      const response = await fetch(`${this.getBaseUrl()}${finalPath}`, options)\n\n      if (response.status >= 200 && response.status < 300) {\n        return await response.json()\n      } else {\n        const message = `Starlight - GET ${path} returned ${response.status}: ${response.statusText}`\n        throw new StarlightError(message, response)\n      }\n    },\n\n    get models() {\n      return makeModelSelector(this)\n    },\n\n    model(slug) {\n      return makeModelInstance(this, slug as string)\n    },\n\n    get singletons() {\n      return makeSingletonSelector(this)\n    },\n\n    get collections() {\n      return makeCollectionSelector(this)\n    },\n\n    collection(slug: string | number) {\n      return makeCollectionInstance(this, slug)\n    },\n\n    get media() {\n      return makeMediaSelector(this)\n    },\n\n    get search() {\n      return makeSearchSelector(this)\n    },\n  }\n\n  return new Proxy(client, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeModelInstance(target, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicStarlightClient<D & WorkspaceModelDefinition>\n}\n"]}

package/dist/cjs/src/client.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client.spec.d.ts.map

package/dist/cjs/src/client.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.spec.d.ts","sourceRoot":"","sources":["../../../src/client.spec.ts"],"names":[],"mappings":""}

package/dist/cjs/src/client.spec.js

@@ -0,0 +1,26 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const client_1 = require("./client");
+const fixtures_1 = require("../mocks/fixtures");
+(0, vitest_1.describe)('API: address endpoint', () => {
+    (0, vitest_1.it)('should return the proper model object', () => __awaiter(void 0, void 0, void 0, function* () {
+        const Client = (0, client_1.makeClient)({ workspace: 'test-workspace' });
+        const models = yield Client.models.list();
+        (0, vitest_1.expect)(models).toEqual(fixtures_1.modelsListMock);
+    }));
+    (0, vitest_1.it)('should throw error when no workspace is specified', () => __awaiter(void 0, void 0, void 0, function* () {
+        const Client = (0, client_1.makeClient)();
+        (0, vitest_1.expect)(Client.getBaseUrl).toThrowError('No workspace defined. Use the `configure()` method on the Starlight client to define one.');
+    }));
+});
+//# sourceMappingURL=client.spec.js.map

package/dist/cjs/src/client.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.spec.js","sourceRoot":"","sources":["../../../src/client.spec.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,mCAA6C;AAE7C,qCAAqC;AACrC,gDAAkD;AAElD,IAAA,iBAAQ,EAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAA,WAAE,EAAC,uCAAuC,EAAE,GAAS,EAAE;QACrD,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,EAAE,SAAS,EAAE,gBAAgB,EAAE,CAAC,CAAA;QAC1D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAA;QAEzC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC,yBAAc,CAAC,CAAA;IACxC,CAAC,CAAA,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAS,EAAE;QACjE,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAA;QAE3B,IAAA,eAAM,EAAC,MAAM,CAAC,UAAU,CAAC,CAAC,YAAY,CACpC,2FAA2F,CAC5F,CAAA;IACH,CAAC,CAAA,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA","sourcesContent":["import { describe, it, expect } from 'vitest'\n\nimport { makeClient } from './client'\nimport { modelsListMock } from '../mocks/fixtures'\n\ndescribe('API: address endpoint', () => {\n  it('should return the proper model object', async () => {\n    const Client = makeClient({ workspace: 'test-workspace' })\n    const models = await Client.models.list()\n\n    expect(models).toEqual(modelsListMock)\n  })\n\n  it('should throw error when no workspace is specified', async () => {\n    const Client = makeClient()\n\n    expect(Client.getBaseUrl).toThrowError(\n      'No workspace defined. Use the `configure()` method on the Starlight client to define one.'\n    )\n  })\n})\n"]}

package/dist/cjs/src/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACI,QAAQ,EAAE,QAAQ,CAAA;gBAEb,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;CAIhD"}

package/dist/cjs/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/errors.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,MAAa,cAAe,SAAQ,KAAK;IA+BvC,YAAY,OAAe,EAAE,QAAkB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;IAC1B,CAAC;CACF;AAnCD,wCAmCC","sourcesContent":["/**\n * This error is thrown every time a problem occurs when requesting something\n * from Starlight's APIs. When it does, you can inspect the attached response\n * to verify what kind of problem happened and handle it accordingly.\n *\n * @group Errors\n */\nexport class StarlightError extends Error {\n  /**\n   * The response provided by the `fetch` method when the error occurred.\n   *\n   * @example Using the `response` property to handle 404 errors.\n   *\n   * ```ts\n   * import Starlight, { StarlightError } from '@starlightcms/js-sdk'\n   *\n   * // Returns either an Entry, null on 404 errors, or false in all other cases\n   * const requestEntry = async (slug) => {\n   *   try {\n   *     const response = await Starlight.posts.entries.get(slug)\n   *\n   *     return response.data\n   *   } catch (error) {\n   *     if (error instanceof StarlightError && error.response.status === 404) {\n   *       // Return null to indicate a 404 error\n   *       return null\n   *     }\n   *\n   *     // Return false in all other error scenarios\n   *     return false\n   *   }\n   * }\n   * ```\n   *\n   * @see [MDN documentation on the Response object](https://developer.mozilla.org/en-US/docs/Web/API/Response)\n   */\n  public response: Response\n\n  constructor(message: string, response: Response) {\n    super(message)\n    this.response = response\n  }\n}\n"]}

package/dist/{esm → cjs/src}/index.d.ts

@@ -22,7 +22,7 @@ export * from './types';
  *
  * @group Client
  */
-declare const Starlight: import("./types").DynamicStarlightClient<import("./types").DefaultModelDefinition>;
+declare const Starlight: import("./types").DynamicStarlightClient<import("./types").DefaultModelDefinition & import("./types").WorkspaceModelDefinition>;
 export { makeClient as makeStarlightClient };
 export default Starlight;
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AACrC,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,cAAc,SAAS,CAAA;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,SAAS,iIAAe,CAAA;AAE9B,OAAO,EAAE,UAAU,IAAI,mBAAmB,EAAE,CAAA;AAE5C,eAAe,SAAS,CAAA"}

package/dist/cjs/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qCAAqC;AA2Bd,oGA3Bd,mBAAU,OA2BuB;AA1B1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,0CAAuB;AAEvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { StarlightError } from './errors'\nexport * from './types'\n\n/**\n * This is the default object exported by the SDK module, which is a\n * pre-created {@link StarlightClient}. In the docs, this is called the \"global\n * SDK client\". If your application only requests data from a single Starlight\n * workspace, using this client is easier than creating\n * a new one using {@link makeStarlightClient}.\n *\n * Using the default client is as easy as importing the SDK:\n *\n * ```ts\n * // \"Starlight\" below is the default client.\n * import Starlight from '@starlightcms/js-sdk'\n *\n * const response = await Starlight.posts.entries.list()\n * ```\n *\n * You need to configure the default workspace before using it.\n * See {@apilink StarlightClient.configure} to learn more.\n *\n * @group Client\n */\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}

package/dist/cjs/src/instances/Collection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/instances/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACpE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAEvE,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,CAAC,SAAS,qBAAqB,GAAG,OAAO,EACzC,MAAM,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAU7E;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,CAAA"}

package/dist/cjs/src/instances/Collection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/instances/Collection/index.ts"],"names":[],"mappings":";;AAGA,SAAwB,sBAAsB,CAE5C,MAAuB,EAAE,UAA2B;IACpD,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,EAAE,CAAC,CAAA;QACjD,CAAC;QAED,KAAK,CAAC,OAAO;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,UAAU,QAAQ,EAAE,OAAO,CAAC,CAAA;QAChE,CAAC;KACF,CAAA;AACH,CAAC;AAZD,yCAYC","sourcesContent":["import { CollectionEntityTypes, StarlightClient } from '../../types'\nimport { CollectionInstance, ListCollectionItemsParams } from './types'\n\nexport default function makeCollectionInstance<\n  T extends CollectionEntityTypes = unknown\n>(client: StarlightClient, collection: string | number): CollectionInstance<T> {\n  return {\n    get() {\n      return client.get(`/collections/${collection}`)\n    },\n\n    items(options) {\n      return client.get(`/collections/${collection}/items`, options)\n    },\n  }\n}\n\nexport { CollectionInstance, ListCollectionItemsParams }\n"]}

package/dist/{esm → cjs/src}/instances/Collection/types.d.ts

@@ -66,6 +66,6 @@ export interface CollectionInstance<C extends CollectionEntityTypes> {
      * {@link ListCollectionItemsParams} for all available options. `field:foo`
      * syntax is also supported, see {@link QueryableFields} for more info.
      */
-    items(options?: ListCollectionItemsParams & WithQueryableFieldsOnModelables<C>): Promise<StarlightListResponse<C>>;
+    items(options?: ListCollectionItemsParams | WithQueryableFieldsOnModelables<C>): Promise<StarlightListResponse<C>>;
 }
 //# sourceMappingURL=types.d.ts.map

package/dist/cjs/src/instances/Collection/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/instances/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,qBAAqB,EACrB,oBAAoB,EACpB,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,+BAA+B,EAChC,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,yBACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,qBAAqB;IACjE;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,KAAK,CACH,OAAO,CAAC,EAAE,yBAAyB,GAAG,+BAA+B,CAAC,CAAC,CAAC,GACvE,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC,CAAA;CACrC"}

package/dist/cjs/src/instances/Collection/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/instances/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Collection,\n  CollectionEntityTypes,\n  CollectionTypeMapper,\n  QueryableRequestParameters,\n  StarlightItemResponse,\n  StarlightListResponse,\n  WithQueryableFieldsOnModelables,\n} from '../../types'\n\n/**\n * Request parameters for listing collection items.\n *\n * Used by {@apilink CollectionInstance.items}.\n *\n * @group Request Parameters\n */\nexport interface ListCollectionItemsParams\n  extends BaseRequestParameters,\n    QueryableRequestParameters {\n  /**\n   * Define how entries will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'views:asc'\n    | 'views:desc'\n}\n\n/**\n * An Instance that provide methods to request information and items from\n * a specific {@link Collection}.\n *\n * You can access a CollectionInstance using\n * {@apilink StarlightClient.collection}.\n *\n * To list all workspace collections, use a {@link CollectionSelector}.\n *\n * @group Instances\n */\nexport interface CollectionInstance<C extends CollectionEntityTypes> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Collection}.\n   *\n   * @example Requesting information from a collection of slug `featured-news`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection('featured-news').get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<Collection<CollectionTypeMapper<C>>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of items of this\n   * {@link Collection}. The returned list type depends on the collection type:\n   * a list of {@apilink Entry | Entries} for a collection of type `entry`, a\n   * list of {@apilink MediaObject | MediaObjects} for a collection o type\n   * `media`, and so on.\n   *\n   * If the given Collection is not typed, this method will return a response of\n   * `StarlightListResponse<unknown>`.\n   *\n   * @example Requesting all items from an Entry collection of slug `featured-news`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collection('featured-news').items()\n   * ```\n   *\n   * @example Explicitly typing the returned items. Only possible in TypeScript.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   * import { NewsPostType } from '../types'\n   *\n   * // response will be StarlightListResponse<Entry<NewsPostType>>\n   * const response = await Starlight.collection<Entry<NewsPostType>>('featured-news').items()\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListCollectionItemsParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  items(\n    options?: ListCollectionItemsParams | WithQueryableFieldsOnModelables<C>\n  ): Promise<StarlightListResponse<C>>\n}\n"]}

package/dist/cjs/src/instances/Model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/instances/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EAEhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAS7D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAChE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,oBAAoB,CAAC,CAAC,CAAC,CA4BzB;AAED,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,CAAA"}

package/dist/cjs/src/instances/Model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/instances/Model/index.ts"],"names":[],"mappings":";;;;;AAOA,kEAAwE;AACxE,kFAEsC;AACtC,qEAEyB;AAEzB,SAAwB,iBAAiB,CACvC,MAAuB,EACvB,KAAa;IAEb,MAAM,QAAQ,GAAG;QACf,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,EAAE,CAAC,CAAA;QACvC,CAAC;QAED,QAAQ,CAAC,IAAY;YACnB,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QACvD,CAAC;QAED,IAAI,OAAO;YACT,OAAO,IAAA,eAAiB,EAAI,MAAM,EAAE,KAAK,CAAC,CAAA;QAC5C,CAAC;QAED,IAAI,UAAU;YACZ,OAAO,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACjD,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,IAAA,uBAAyB,EAAC,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;aACtD;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA4B,CAAA;AAC/B,CAAC;AA/BD,oCA+BC","sourcesContent":["import {\n  Model,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n} from '../../types'\nimport { DynamicModelInstance, ModelInstance } from './types'\nimport makeEntrySelector, { EntrySelector } from '../../selectors/Entry'\nimport makeModelCategorySelector, {\n  DynamicModelCategorySelector,\n} from '../../selectors/ModelCategory'\nimport makeModelCategoryInstance, {\n  ModelCategoryInstance,\n} from '../ModelCategory'\n\nexport default function makeModelInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): DynamicModelInstance<D> {\n  const instance = {\n    get(): Promise<StarlightItemResponse<Model>> {\n      return client.get(`/models/${model}`)\n    },\n\n    category(slug: string): ModelCategoryInstance<D> {\n      return makeModelCategoryInstance(client, model, slug)\n    },\n\n    get entries(): EntrySelector<D> {\n      return makeEntrySelector<D>(client, model)\n    },\n\n    get categories(): DynamicModelCategorySelector<D> {\n      return makeModelCategorySelector(client, model)\n    },\n  }\n\n  return new Proxy(instance, {\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 DynamicModelInstance<D>\n}\n\nexport { DynamicModelInstance, ModelInstance }\n"]}

package/dist/cjs/src/instances/Model/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/instances/Model/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAC1E,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,+BAA+B,CAAA;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAA;AAExD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAA;IAE5C;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAEhD;;;;;;;;;;;;OAYG;IACH,IAAI,OAAO,IAAI,aAAa,CAAC,CAAC,CAAC,CAAA;IAE/B;;;;;;;;;;;;OAYG;IACH,IAAI,UAAU,IAAI,4BAA4B,CAAC,CAAC,CAAC,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,oBAAoB,CAAC,CAAC,SAAS,cAAc,IACvD,aAAa,CAAC,CAAC,CAAC,GAAG;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAA;CACxC,CAAA"}

package/dist/cjs/src/instances/Model/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/instances/Model/types.ts"],"names":[],"mappings":"","sourcesContent":["import { Model, SerializedData, StarlightItemResponse } from '../../types'\nimport { EntrySelector } from '../../selectors/Entry'\nimport { DynamicModelCategorySelector } from '../../selectors/ModelCategory'\nimport { ModelCategoryInstance } from '../ModelCategory'\n\n/**\n * An Instance that provide methods to request information from a {@link Model},\n * its {@apilink Entry | Entries}, and its {@apilink ModelCategory | Categories}.\n *\n * You can access a ModelInstance using {@apilink StarlightClient.model} or\n * using the dynamic syntax on a {@link DynamicStarlightClient}. Usage\n * examples will use the dynamic syntax.\n *\n * To list all workspace models, use a {@link ModelSelector}.\n *\n * @group Instances\n */\nexport interface ModelInstance<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Model}.\n   *\n   * @example Requesting information from a model of slug `posts`.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<Model>>\n\n  /**\n   * Returns a {@link ModelCategoryInstance}.\n   *\n   * If you're using a {@link DynamicModelInstance}, you can use the\n   * dynamic syntax instead of this method.\n   *\n   * @example Listing all entries from the \"news\" category of a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.category('news').entries()\n   * ```\n   *\n   * @param slug The category slug.\n   */\n  category(slug: string): ModelCategoryInstance<D>\n\n  /**\n   * Returns an {@link EntrySelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * // \"entries\" below is an EntrySelector.\n   * const response = await Starlight.posts.entries.list()\n   * ```\n   */\n  get entries(): EntrySelector<D>\n\n  /**\n   * Returns a {@link DynamicModelCategorySelector}.\n   *\n   * This is an accessor, which means that it should be used just like a common\n   * object parameter. For instance:\n   *\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * // \"categories\" below is a DynamicModelCategorySelector.\n   * const response = await Starlight.posts.categories.get('interviews')\n   * ```\n   */\n  get categories(): DynamicModelCategorySelector<D>\n}\n\n/**\n * An Instance that provide all {@link ModelInstance} methods and adds support\n * for creating {@apilink ModelCategoryInstance | ModelCategoryInstances} using\n * the dynamic syntax.\n *\n * See {@link ModelInstance} to view all available methods.\n *\n * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n * @example Accessing a ModelCategoryInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"articles\" below will be a ModelCategoryInstance.\n * const response = await Starlight.posts.articles.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicModelInstance<D extends SerializedData> =\n  ModelInstance<D> & {\n    [key: string]: ModelCategoryInstance<D>\n  }\n"]}

package/dist/cjs/src/instances/ModelCategory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,cAAc,EACd,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,MAAM,SAAS,CAAA;AAE7E,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAAC,CAAC,SAAS,cAAc,EACxE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,GACf,qBAAqB,CAAC,CAAC,CAAC,CAc1B;AAED,OAAO,EAAE,qBAAqB,EAAE,4BAA4B,EAAE,CAAA"}

package/dist/cjs/src/instances/ModelCategory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/instances/ModelCategory/index.ts"],"names":[],"mappings":";;AAWA,SAAwB,yBAAyB,CAC/C,MAAuB,EACvB,KAAa,EACb,QAAgB;IAEhB,OAAO;QACL,GAAG;YACD,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,eAAe,QAAQ,EAAE,CAAC,CAAA;QAC9D,CAAC;QACD,OAAO,CACL,OAA0D;YAE1D,OAAO,MAAM,CAAC,GAAG,CACf,WAAW,KAAK,eAAe,QAAQ,UAAU,EACjD,OAAO,CACR,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAlBD,4CAkBC","sourcesContent":["import {\n  Entry,\n  ModelCategory,\n  QueryableFields,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { ModelCategoryInstance, ModelCategoryEntryListParams } from './types'\n\nexport default function makeModelCategoryInstance<D extends SerializedData>(\n  client: StarlightClient,\n  model: string,\n  category: string\n): ModelCategoryInstance<D> {\n  return {\n    get(): Promise<StarlightItemResponse<ModelCategory>> {\n      return client.get(`/models/${model}/categories/${category}`)\n    },\n    entries(\n      options: ModelCategoryEntryListParams & QueryableFields<D>\n    ): Promise<StarlightListResponse<Entry<D>>> {\n      return client.get(\n        `/models/${model}/categories/${category}/entries`,\n        options\n      )\n    },\n  }\n}\n\nexport { ModelCategoryInstance, ModelCategoryEntryListParams }\n"]}

package/dist/cjs/src/instances/ModelCategory/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,aAAa,EACb,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,4BACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;CACjB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,qBAAqB,CAAC,CAAC,SAAS,cAAc;IAC7D;;;;;;;;;OASG;IACH,GAAG,IAAI,OAAO,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC,CAAA;IAEpD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,OAAO,CACL,OAAO,CAAC,EAAE,4BAA4B,GAAG,eAAe,CAAC,CAAC,CAAC,GAC1D,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}

package/dist/cjs/src/instances/ModelCategory/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/instances/ModelCategory/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Entry,\n  ModelCategory,\n  QueryableFields,\n  QueryableRequestParameters,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for listing category entries.\n *\n * Used by {@apilink ModelCategoryInstance.entries}.\n *\n * @group Request Parameters\n */\nexport interface ModelCategoryEntryListParams\n  extends BaseRequestParameters,\n    QueryableRequestParameters {\n  /**\n   * Define how entries will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'views:asc'\n    | 'views:desc'\n}\n\n/**\n * An Instance that provide methods to request information from a\n * {@link ModelCategory} and its {@apilink Entry | Entries}.\n *\n * You can access a ModelCategoryInstance using\n * {@apilink ModelInstance.category} or using the dynamic syntax on a\n * {@link DynamicModelInstance}. Usage examples will use the dynamic syntax.\n *\n * To list all categories from a model, use a {@link ModelCategorySelector}.\n *\n * @group Instances\n */\nexport interface ModelCategoryInstance<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link ModelCategory}.\n   *\n   * @example Requesting information from a category called \"articles\" in a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.articles.get()\n   * ```\n   */\n  get(): Promise<StarlightItemResponse<ModelCategory>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of entries of this\n   * {@link ModelCategory}.\n   *\n   * @example Requesting all items from a category called \"gaming\" in a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.gaming.items()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.gaming.items({\n   *   page: 5,\n   *   query: 'kirby'\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ModelCategoryEntryListParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  entries(\n    options?: ModelCategoryEntryListParams & QueryableFields<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}

package/dist/cjs/src/selectors/Collection/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EACL,kBAAkB,EAClB,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAGhB,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAC5C,MAAM,EAAE,eAAe,GACtB,yBAAyB,CAoB3B;AAED,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,CAAA"}

package/dist/cjs/src/selectors/Collection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/selectors/Collection/index.ts"],"names":[],"mappings":";;;;;AAMA,4EAA+D;AAE/D,SAAwB,sBAAsB,CAC5C,MAAuB;IAEvB,MAAM,QAAQ,GAAuB;QACnC,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,cAAc,oBAAO,OAAO,EAAG,CAAA;QACnD,CAAC;QAED,GAAG,CAAC,IAAI;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;QAC3C,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,IAAA,oBAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;aAC5C;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC;AAtBD,yCAsBC","sourcesContent":["import { StarlightClient } from '../../types'\nimport {\n  CollectionSelector,\n  DynamicCollectionSelector,\n  ListCollectionsParams,\n} from './types'\nimport makeCollectionInstance from '../../instances/Collection'\n\nexport default function makeCollectionSelector(\n  client: StarlightClient\n): DynamicCollectionSelector {\n  const selector: CollectionSelector = {\n    list(options) {\n      return client.get('/collections', { ...options })\n    },\n\n    get(slug) {\n      return client.get(`/collections/${slug}`)\n    },\n  }\n\n  return new Proxy(selector, {\n    get(target, prop) {\n      if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n        return makeCollectionInstance(client, prop)\n      }\n\n      return Reflect.get(target, prop)\n    },\n  }) as DynamicCollectionSelector\n}\n\nexport { CollectionSelector, DynamicCollectionSelector, ListCollectionsParams }\n"]}

package/dist/cjs/src/selectors/Collection/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,UAAU,EACV,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAClE;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,YAAY,GAAG,gBAAgB,GAAG,iBAAiB,CAAA;CAC1E;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;IAE7C;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAA;CACvE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,oBAAY,yBAAyB,GAAG,kBAAkB,GAAG;IAC3D,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAA;CAC3C,CAAA"}

package/dist/cjs/src/selectors/Collection/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/selectors/Collection/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Collection,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { CollectionInstance } from '../../instances/Collection'\n\n/**\n * Request parameters for listing collections.\n *\n * Used by {@apilink CollectionSelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListCollectionsParams extends BaseRequestParameters {\n  /**\n   * Define how items will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?: 'title:asc' | 'title:desc' | 'item_count:asc' | 'item_count:desc'\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Collection | Collections}.\n *\n * You can use a CollectionSelector by accessing\n * {@apilink StarlightClient.collections}.\n *\n * To get items from a specific collection, use a {@link CollectionInstance}.\n *\n * @group Selectors\n */\nexport interface CollectionSelector {\n  /**\n   * Returns a {@link StarlightListResponse} with the list of\n   * {@apilink Collection | Collections} in this workspace.\n   *\n   * @example Requesting all collections from the workspace.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.list()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.list({\n   *   page: 2,\n   *   query: 'photos',\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListCollectionsParams} for all available options.\n   */\n  list(\n    options?: ListCollectionsParams\n  ): Promise<StarlightListResponse<Collection>>\n\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Collection}.\n   *\n   * @example Requesting information from a collection of slug \"event-photos\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.collections.get('event-photos')\n   * ```\n   *\n   * @param slug The collection slug.\n   */\n  get(slug: string | number): Promise<StarlightItemResponse<Collection>>\n}\n\n/**\n * A Selector that provide all {@link CollectionSelector} methods and adds\n * support for creating {@apilink CollectionInstance | CollectionInstances}\n * using the dynamic syntax.\n *\n * See {@link CollectionSelector} to view all available methods.\n *\n * See {@doclink requests-and-responses#dynamic-syntax | Dynamic Instances}\n * documentation to learn more about the dynamic syntax.\n *\n * @example Accessing a CollectionInstance using the dynamic syntax.\n * ```ts\n * import Starlight from '@starlightcms/js-sdk'\n *\n * // \"sliders\" below will be a CollectionInstance.\n * const response = await Starlight.collections.sliders.list()\n * ```\n *\n * @category Instances\n */\nexport type DynamicCollectionSelector = CollectionSelector & {\n  [key: string]: CollectionInstance<unknown>\n}\n"]}

package/dist/cjs/{selectors → src/selectors}/Entry/index.d.ts

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

package/dist/cjs/src/selectors/Entry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Entry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,cAAc,EACd,eAAe,EAGhB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE1D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,cAAc,EAChE,MAAM,EAAE,eAAe,EACvB,KAAK,EAAE,MAAM,GACZ,aAAa,CAAC,CAAC,CAAC,CAclB;AAED,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,CAAA"}

package/dist/cjs/src/selectors/Entry/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/selectors/Entry/index.ts"],"names":[],"mappings":";;AASA,SAAwB,iBAAiB,CACvC,MAAuB,EACvB,KAAa;IAEb,OAAO;QACL,IAAI,CAAC,OAAO;YACV,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,UAAU,EAAE,OAAO,CAAC,CAAA;QACxD,CAAC;QAED,GAAG,CACD,IAAY,EACZ,MAAM,EACN,OAAO;YAEP,OAAO,MAAM,CAAC,GAAG,CAAC,WAAW,KAAK,YAAY,IAAI,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;QACxE,CAAC;KACF,CAAA;AACH,CAAC;AAjBD,oCAiBC","sourcesContent":["import {\n  Entry,\n  SerializedData,\n  StarlightClient,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\nimport { EntrySelector, ListEntriesParams } from './types'\n\nexport default function makeEntrySelector<D extends SerializedData>(\n  client: StarlightClient,\n  model: string\n): EntrySelector<D> {\n  return {\n    list(options): Promise<StarlightListResponse<Entry<D>>> {\n      return client.get(`/models/${model}/entries`, options)\n    },\n\n    get(\n      slug: string,\n      params,\n      options\n    ): Promise<StarlightItemResponse<Entry<D>>> {\n      return client.get(`/models/${model}/entries/${slug}`, params, options)\n    },\n  }\n}\n\nexport { EntrySelector, ListEntriesParams }\n"]}

package/dist/cjs/{selectors → src/selectors}/Entry/types.d.ts

@@ -20,6 +20,27 @@ export interface ListEntriesParams extends BaseRequestParameters, QueryableReque
      * allowed options.
      */
     order?: 'title:asc' | 'title:desc' | 'published_at:asc' | 'published_at:desc' | 'views:asc' | 'views:desc';
+    /**
+     * When false, the returned entries won't have any data attached to them,
+     * even if their Model have listable fields. Defaults to true.
+     */
+    data?: boolean;
+    /**
+     * When given, return entries published before the given date. Should be an
+     * ISO 8601 date string.
+     *
+     * Tip: in JavaScript, you can get an ISO 8601 date string by using
+     * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
+     */
+    published_before?: string;
+    /**
+     * When given, return entries published after the given date. Should be an
+     * ISO 8601 date string.
+     *
+     * Tip: in JavaScript, you can get an ISO 8601 date string by using
+     * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
+     */
+    published_after?: string;
 }
 /**
  * Request parameters for getting an entry.

package/dist/cjs/src/selectors/Entry/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,EACL,eAAe,EACf,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAC3B,0BAA0B;IAC5B;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,KAAK,CAAC,EACF,WAAW,GACX,YAAY,GACZ,kBAAkB,GAClB,mBAAmB,GACnB,WAAW,GACX,YAAY,CAAA;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;IACd;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;GAMG;AACH,oBAAY,cAAc,GAAG;IAC3B;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,cAAc;IACrD;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,IAAI,CACF,OAAO,CAAC,EAAE,iBAAiB,GAAG,eAAe,CAAC,CAAC,CAAC,GAC/C,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;CAC5C"}

package/dist/cjs/src/selectors/Entry/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/selectors/Entry/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  BaseRequestParameters,\n  Entry,\n  QueryableFields,\n  QueryableRequestParameters,\n  SerializedData,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * Request parameters for listing entries.\n *\n * Used by {@apilink EntrySelector.list}.\n *\n * @group Request Parameters\n */\nexport interface ListEntriesParams\n  extends BaseRequestParameters,\n    QueryableRequestParameters {\n  /**\n   * A comma-separated list of categories. Only entries in these categories\n   * will be returned. If undefined, all entries in the model will be listed.\n   *\n   * For instance, to show only entries in the \"news\" and \"articles\" categories,\n   * pass `'news,category'`.\n   */\n  categories?: string\n  /**\n   * Define how items will be ordered. Check this field type to see the\n   * allowed options.\n   */\n  order?:\n    | 'title:asc'\n    | 'title:desc'\n    | 'published_at:asc'\n    | 'published_at:desc'\n    | 'views:asc'\n    | 'views:desc'\n  /**\n   * When false, the returned entries won't have any data attached to them,\n   * even if their Model have listable fields. Defaults to true.\n   */\n  data?: boolean\n  /**\n   * When given, return entries published before the given date. Should be an\n   * ISO 8601 date string.\n   *\n   * Tip: in JavaScript, you can get an ISO 8601 date string by using\n   * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).\n   */\n  published_before?: string\n  /**\n   * When given, return entries published after the given date. Should be an\n   * ISO 8601 date string.\n   *\n   * Tip: in JavaScript, you can get an ISO 8601 date string by using\n   * [Date.toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).\n   */\n  published_after?: string\n}\n\n/**\n * Request parameters for getting an entry.\n *\n * Used by {@apilink EntrySelector.get}.\n *\n * @group Request Parameters\n */\nexport type GetEntryParams = {\n  /**\n   * Preview token generated by the Starlight admin interface. If defined and\n   * valid, the API will return a preview of the entry revision associated\n   * with the token.\n   */\n  preview?: string\n}\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink Entry | Entries}.\n *\n * You can use an EntrySelector by accessing\n * {@apilink ModelInstance.entries}.\n *\n * @group Selectors\n */\nexport interface EntrySelector<D extends SerializedData> {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link Entry}.\n   * Supports revision previewing by passing a `preview` parameter.\n   *\n   * @example Requesting information from an entry \"hello-world\" from a model of slug \"posts\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.entries.get('hello-world')\n   * ```\n   *\n   * @example Passing a preview token on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.posts.entries.get('hello-world', {\n   *   preview: 'CDfkvt1zTF5XhxWzi2Lejgo1'\n   * })\n   * ```\n   *\n   * @param slug The entry slug.\n   * @param params An optional object of request parameters. See\n   * {@link GetEntryParams} for all available options.\n   * @param options An optional object of Fetch parameters. Use it to modify\n   * the fetch request.See [MDN documentation on fetch()](https://developer.mozilla.org/en-US/docs/Web/API/fetch)\n   * for all available options.\n   */\n  get(\n    slug: string,\n    params?: GetEntryParams,\n    options?: RequestInit\n  ): Promise<StarlightItemResponse<Entry<D>>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with a list of\n   * {@apilink Entry | Entries}.\n   *\n   * @example Requesting all entries from a model of slug \"recipes\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list()\n   * ```\n   *\n   * @example Paginating and searching on the last example.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list({\n   *   page: 2,\n   *   query: 'gravy',\n   *   'field:is_vegan': true,\n   * })\n   * ```\n   *\n   * @example Ordering entries by number of views.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.recipes.entries.list({\n   *   order: 'views:desc'\n   * })\n   * ```\n   *\n   * @param options An optional object of request parameters. See\n   * {@link ListEntriesParams} for all available options. `field:foo`\n   * syntax is also supported, see {@link QueryableFields} for more info.\n   */\n  list(\n    options?: ListEntriesParams & QueryableFields<D>\n  ): Promise<StarlightListResponse<Entry<D>>>\n}\n"]}

package/dist/cjs/src/selectors/Media/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Media/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,CAAC,OAAO,UAAU,iBAAiB,CACvC,MAAM,EAAE,eAAe,GACtB,aAAa,CAUf;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/dist/cjs/src/selectors/Media/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/selectors/Media/index.ts"],"names":[],"mappings":";;AAGA,SAAwB,iBAAiB,CACvC,MAAuB;IAEvB,OAAO;QACL,IAAI;YACF,OAAO,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QAED,GAAG,CAAC,EAAE;YACJ,OAAO,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;QACnC,CAAC;KACF,CAAA;AACH,CAAC;AAZD,oCAYC","sourcesContent":["import { StarlightClient } from '../../types'\nimport { MediaSelector } from './types'\n\nexport default function makeMediaSelector(\n  client: StarlightClient\n): MediaSelector {\n  return {\n    list() {\n      return client.get('/media')\n    },\n\n    get(id) {\n      return client.get(`/media/${id}`)\n    },\n  }\n}\n\nexport { MediaSelector }\n"]}

package/dist/cjs/src/selectors/Media/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;IAErE;;;;;;;;;;OAUG;IACH,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAA;CACpD"}

package/dist/cjs/src/selectors/Media/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../src/selectors/Media/types.ts"],"names":[],"mappings":"","sourcesContent":["import {\n  MediaObject,\n  StarlightItemResponse,\n  StarlightListResponse,\n} from '../../types'\n\n/**\n * A Selector that provide methods to list and request information on\n * {@apilink MediaObject | MediaObjects}.\n *\n * You can use a MediaSelector by accessing\n * {@apilink StarlightClient.media}.\n *\n * @group Selectors\n */\nexport interface MediaSelector {\n  /**\n   * Returns a {@link StarlightItemResponse} with a single {@link MediaObject}.\n   *\n   * Note: MediaObjects are identified by their IDs, since they don't have slugs.\n   *\n   * @example Requesting information from a media object of id \"123456789\".\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.media.get('123456789')\n   * ```\n   *\n   * @param id The media object ID.\n   */\n  get(id: number | string): Promise<StarlightItemResponse<MediaObject>>\n\n  /**\n   * Returns a {@link StarlightListResponse} with the list of\n   * {@apilink MediaObject | MediaObjects} in this workspace.\n   *\n   * @example Requesting all media objects from the workspace.\n   * ```ts\n   * import Starlight from '@starlightcms/js-sdk'\n   *\n   * const response = await Starlight.media.list()\n   * ```\n   */\n  list(): Promise<StarlightListResponse<MediaObject>>\n}\n"]}

package/dist/cjs/src/selectors/Model/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/selectors/Model/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,eAAe,EAGf,wBAAwB,EACzB,MAAM,aAAa,CAAA;AACpB,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAG7D,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,CAAC,SAAS,wBAAwB,EAC1E,MAAM,EAAE,eAAe,GACtB,oBAAoB,CAAC,CAAC,CAAC,CAoBzB;AAED,OAAO,EAAE,aAAa,EAAE,oBAAoB,EAAE,CAAA"}