@starlightcms/js-sdk 0.1.7 → 0.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +0 -4
- package/dist/client.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/selectors/EntrySelector.d.ts +2 -2
- package/dist/selectors/EntrySelector.d.ts.map +1 -1
- package/dist/selectors/EntrySelector.js +2 -1
- package/dist/selectors/EntrySelector.js.map +1 -1
- package/dist/types/index.d.ts +5 -4
- package/dist/types/index.d.ts.map +1 -1
- package/dist/types/index.js +1 -0
- package/dist/types/index.js.map +1 -1
- package/dist/types/visual.d.ts +21 -2
- package/dist/types/visual.d.ts.map +1 -1
- package/dist/types/visual.js.map +1 -1
- package/package.json +4 -3
- package/dist/types.d.ts +0 -74
- package/dist/types.d.ts.map +0 -1
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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;
|
|
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;AAKhB,wBAAgB,UAAU,CACxB,CAAC,SAAS,wBAAwB,GAAG,sBAAsB,EAC3D,MAAM,GAAE,eAAoB,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAkDzD"}
|
package/dist/client.js
CHANGED
|
@@ -16,10 +16,6 @@ exports.makeClient = void 0;
|
|
|
16
16
|
const errors_1 = require("./errors");
|
|
17
17
|
const EntrySelector_1 = __importDefault(require("./selectors/EntrySelector"));
|
|
18
18
|
const ModelSelector_1 = __importDefault(require("./selectors/ModelSelector"));
|
|
19
|
-
// TODO: tentar entender porque que list() e get() agora retornam Promise<any>
|
|
20
|
-
// talvez se resolva quando publicar e pegar do npm?
|
|
21
|
-
// TODO: criar o pacote react que exporta esse pacote, além de serializadores
|
|
22
|
-
// para os fields
|
|
23
19
|
function makeClient(config = {}) {
|
|
24
20
|
var _a, _b, _c;
|
|
25
21
|
let baseUrl = (_a = config.baseUrl) !== null && _a !== void 0 ? _a : 'https://query.starlight.sh/v2';
|
package/dist/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,qCAAyC;AACzC,8EAAqD;AACrD,8EAAqD;AAErD,
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAOA,qCAAyC;AACzC,8EAAqD;AACrD,8EAAqD;AAErD,SAAgB,UAAU,CAExB,SAA0B,EAAE;;IAC5B,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,MAAuB;;YAC/B,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;QACD,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc;YAC5B,IAAI,KAAK;gBAAE,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,cAAc,CAAC,CAAA;QACpD,CAAC;QACD,UAAU;YACR,OAAO,GAAG,OAAO,eAAe,SAAS,EAAE,CAAA;QAC7C,CAAC;QACK,GAAG,CACP,IAAY,EACZ,OAAqB;;gBAErB,IAAI,CAAC,GAAG,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;gBAEnC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,OAAO,CAAC,CAAA;gBAEpE,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;oBAE7F,MAAM,IAAI,uBAAc,CAAC,OAAO,CAAC,CAAA;iBAClC;YACH,CAAC;SAAA;QACD,gBAAgB,CAAC,IAAY;YAC3B,OAAO,IAAI,uBAAa,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACtC,CAAC;QACD,MAAM;YACJ,OAAO,IAAI,uBAAa,CAAC,IAAI,CAAC,CAAA;QAChC,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,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;aACrC;YAED,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;QAClC,CAAC;KACF,CAA8B,CAAA;AACjC,CAAC;AApDD,gCAoDC","sourcesContent":["import {\n DefaultModelDefinition,\n ProxiedStarlightClient,\n StarlightClient,\n StarlightConfig,\n WorkspaceModelDefinition,\n} from './types'\nimport { StarlightError } from './errors'\nimport EntrySelector from './selectors/EntrySelector'\nimport ModelSelector from './selectors/ModelSelector'\n\nexport function makeClient<\n D extends WorkspaceModelDefinition = DefaultModelDefinition\n>(config: StarlightConfig = {}): ProxiedStarlightClient<D> {\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: StarlightConfig) {\n baseUrl = config.baseUrl ?? baseUrl\n workspace = config.workspace ?? workspace\n debug = config.debug ?? debug\n },\n log(message, ...optionalParams) {\n if (debug) console.log(message, ...optionalParams)\n },\n getBaseUrl(): string {\n return `${baseUrl}/workspaces/${workspace}`\n },\n async get<T = Record<string, unknown>>(\n path: string,\n options?: RequestInit\n ): Promise<T> {\n this.log(`Starlight - GET ${path}`)\n\n const response = await fetch(`${this.getBaseUrl()}${path}`, 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\n throw new StarlightError(message)\n }\n },\n getEntrySelector(slug: string): EntrySelector {\n return new EntrySelector(slug, this)\n },\n models(): ModelSelector {\n return new ModelSelector(this)\n },\n }\n\n return new Proxy(client, {\n get(target, prop) {\n if (typeof prop === 'string' && !Reflect.has(target, prop)) {\n return target.getEntrySelector(prop)\n }\n\n return Reflect.get(target, prop)\n },\n }) as ProxiedStarlightClient<D>\n}\n"]}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { makeClient } from './client';
|
|
|
2
2
|
export { DefaultModelDefinition } from './types';
|
|
3
3
|
export { StarlightError } from './errors';
|
|
4
4
|
export * from './types/fields';
|
|
5
|
+
export * from './types/visual';
|
|
5
6
|
declare const Starlight: import("./types").ProxiedStarlightClient<import("./types").DefaultModelDefinition>;
|
|
6
7
|
export { makeClient as makeStarlightClient };
|
|
7
8
|
export default Starlight;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
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,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,cAAc,gBAAgB,CAAA;AAE9B,QAAA,MAAM,SAAS,oFAAe,CAAA;AAE9B,OAAO,EAAE,UAAU,IAAI,mBAAmB,EAAE,CAAA;AAE5C,eAAe,SAAS,CAAA"}
|
|
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,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AACzC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAE9B,QAAA,MAAM,SAAS,oFAAe,CAAA;AAE9B,OAAO,EAAE,UAAU,IAAI,mBAAmB,EAAE,CAAA;AAE5C,eAAe,SAAS,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -16,6 +16,7 @@ Object.defineProperty(exports, "makeStarlightClient", { enumerable: true, get: f
|
|
|
16
16
|
var errors_1 = require("./errors");
|
|
17
17
|
Object.defineProperty(exports, "StarlightError", { enumerable: true, get: function () { return errors_1.StarlightError; } });
|
|
18
18
|
__exportStar(require("./types/fields"), exports);
|
|
19
|
+
__exportStar(require("./types/visual"), exports);
|
|
19
20
|
const Starlight = (0, client_1.makeClient)();
|
|
20
21
|
exports.default = Starlight;
|
|
21
22
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAqC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;AAAA,qCAAqC;AAQd,oGARd,mBAAU,OAQuB;AAN1C,mCAAyC;AAAhC,wGAAA,cAAc,OAAA;AACvB,iDAA8B;AAC9B,iDAA8B;AAE9B,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAA;AAI9B,kBAAe,SAAS,CAAA","sourcesContent":["import { makeClient } from './client'\nexport { DefaultModelDefinition } from './types'\nexport { StarlightError } from './errors'\nexport * from './types/fields'\nexport * from './types/visual'\n\nconst Starlight = makeClient()\n\nexport { makeClient as makeStarlightClient }\n\nexport default Starlight\n"]}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { Entry, SerializedData, StarlightClient,
|
|
1
|
+
import { Entry, SerializedData, StarlightClient, StarlightListResponse } from '../types';
|
|
2
2
|
export default class EntrySelector<D extends SerializedData = undefined> {
|
|
3
3
|
protected model: string;
|
|
4
4
|
protected client: StarlightClient;
|
|
5
5
|
constructor(model: string, client: StarlightClient);
|
|
6
6
|
list(): Promise<StarlightListResponse<Entry<D>>>;
|
|
7
|
-
get(slug: string): Promise<
|
|
7
|
+
get(slug: string): Promise<Entry<D>>;
|
|
8
8
|
}
|
|
9
9
|
//# sourceMappingURL=EntrySelector.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EntrySelector.d.ts","sourceRoot":"","sources":["../../src/selectors/EntrySelector.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,cAAc,EACd,eAAe,
|
|
1
|
+
{"version":3,"file":"EntrySelector.d.ts","sourceRoot":"","sources":["../../src/selectors/EntrySelector.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,EACL,cAAc,EACd,eAAe,EAEf,qBAAqB,EACtB,MAAM,UAAU,CAAA;AAEjB,MAAM,CAAC,OAAO,OAAO,aAAa,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS;IACrE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAA;IACvB,SAAS,CAAC,MAAM,EAAE,eAAe,CAAA;gBAErB,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe;IAKrC,IAAI,IAAI,OAAO,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAIhD,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CAOlD"}
|
|
@@ -21,7 +21,8 @@ class EntrySelector {
|
|
|
21
21
|
}
|
|
22
22
|
get(slug) {
|
|
23
23
|
return __awaiter(this, void 0, void 0, function* () {
|
|
24
|
-
|
|
24
|
+
const response = yield this.client.get(`/models/${this.model}/entries/${slug}`);
|
|
25
|
+
return response.data;
|
|
25
26
|
});
|
|
26
27
|
}
|
|
27
28
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EntrySelector.js","sourceRoot":"","sources":["../../src/selectors/EntrySelector.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,MAAqB,aAAa;IAIhC,YAAY,KAAa,EAAE,MAAuB;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEY,IAAI;;YACf,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,KAAK,UAAU,CAAC,CAAA;QACzD,CAAC;KAAA;IAEY,GAAG,CAAC,IAAY;;YAC3B,
|
|
1
|
+
{"version":3,"file":"EntrySelector.js","sourceRoot":"","sources":["../../src/selectors/EntrySelector.ts"],"names":[],"mappings":";;;;;;;;;;;AAQA,MAAqB,aAAa;IAIhC,YAAY,KAAa,EAAE,MAAuB;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEY,IAAI;;YACf,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,IAAI,CAAC,KAAK,UAAU,CAAC,CAAA;QACzD,CAAC;KAAA;IAEY,GAAG,CAAC,IAAY;;YAC3B,MAAM,QAAQ,GAAoC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACrE,WAAW,IAAI,CAAC,KAAK,YAAY,IAAI,EAAE,CACxC,CAAA;YAED,OAAO,QAAQ,CAAC,IAAI,CAAA;QACtB,CAAC;KAAA;CACF;AApBD,gCAoBC","sourcesContent":["import {\n Entry,\n SerializedData,\n StarlightClient,\n StarlightItemResponse,\n StarlightListResponse,\n} from '../types'\n\nexport default class EntrySelector<D extends SerializedData = undefined> {\n protected model: string\n protected client: StarlightClient\n\n constructor(model: string, client: StarlightClient) {\n this.model = model\n this.client = client\n }\n\n public async list(): Promise<StarlightListResponse<Entry<D>>> {\n return this.client.get(`/models/${this.model}/entries`)\n }\n\n public async get(slug: string): Promise<Entry<D>> {\n const response: StarlightItemResponse<Entry<D>> = await this.client.get(\n `/models/${this.model}/entries/${slug}`\n )\n\n return response.data\n }\n}\n"]}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import ModelSelector from '../selectors/ModelSelector';
|
|
|
3
3
|
import { SerializedData } from './entities';
|
|
4
4
|
export * from './fields';
|
|
5
5
|
export * from './entities';
|
|
6
|
+
export * from './visual';
|
|
6
7
|
declare type BaseUrl = 'https://query.starlight.sh/v2' | string;
|
|
7
8
|
export declare type StarlightConfig = {
|
|
8
9
|
workspace?: string;
|
|
@@ -20,10 +21,10 @@ export interface StarlightClient {
|
|
|
20
21
|
export declare type ProxiedStarlightClient<T extends WorkspaceModelDefinition> = StarlightClient & {
|
|
21
22
|
[K in keyof T]: EntrySelector<T[K]>;
|
|
22
23
|
};
|
|
23
|
-
export
|
|
24
|
+
export interface StarlightItemResponse<T> {
|
|
24
25
|
data: T;
|
|
25
|
-
}
|
|
26
|
-
export
|
|
26
|
+
}
|
|
27
|
+
export interface StarlightListResponse<T> {
|
|
27
28
|
data: T[];
|
|
28
29
|
links: {
|
|
29
30
|
first: string;
|
|
@@ -39,7 +40,7 @@ export declare type StarlightListResponse<T> = {
|
|
|
39
40
|
per_page: number;
|
|
40
41
|
total: number;
|
|
41
42
|
};
|
|
42
|
-
}
|
|
43
|
+
}
|
|
43
44
|
export interface DefaultModelDefinition extends WorkspaceModelDefinition {
|
|
44
45
|
}
|
|
45
46
|
export interface WorkspaceModelDefinition {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,aAAa,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAE3C,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AAExB,aAAK,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAEvD,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D,UAAU,IAAI,MAAM,CAAA;IAEpB,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;IAE7C,MAAM,IAAI,aAAa,CAAA;CACxB;AAED,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,GAAG;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,CAAA;AAEH,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAA;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF;AAGD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;CAC/B"}
|
package/dist/types/index.js
CHANGED
|
@@ -12,4 +12,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
13
|
__exportStar(require("./fields"), exports);
|
|
14
14
|
__exportStar(require("./entities"), exports);
|
|
15
|
+
__exportStar(require("./visual"), exports);
|
|
15
16
|
//# sourceMappingURL=index.js.map
|
package/dist/types/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,2CAAwB;AACxB,6CAA0B","sourcesContent":["import EntrySelector from '../selectors/EntrySelector'\nimport ModelSelector from '../selectors/ModelSelector'\nimport { SerializedData } from './entities'\n\nexport * from './fields'\nexport * from './entities'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n workspace?: string\n baseUrl?: BaseUrl\n debug?: boolean\n}\n\nexport interface StarlightClient {\n configure(config: StarlightConfig): void\n\n log(message?: unknown, ...optionalParams: unknown[]): void\n\n getBaseUrl(): string\n\n get<T = Record<string, unknown>>(\n path: string,\n options?: RequestInit\n ): Promise<T>\n\n getEntrySelector(slug: string): EntrySelector\n\n models(): ModelSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n StarlightClient & {\n [K in keyof T]: EntrySelector<T[K]>\n }\n\nexport
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB","sourcesContent":["import EntrySelector from '../selectors/EntrySelector'\nimport ModelSelector from '../selectors/ModelSelector'\nimport { SerializedData } from './entities'\n\nexport * from './fields'\nexport * from './entities'\nexport * from './visual'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n workspace?: string\n baseUrl?: BaseUrl\n debug?: boolean\n}\n\nexport interface StarlightClient {\n configure(config: StarlightConfig): void\n\n log(message?: unknown, ...optionalParams: unknown[]): void\n\n getBaseUrl(): string\n\n get<T = Record<string, unknown>>(\n path: string,\n options?: RequestInit\n ): Promise<T>\n\n getEntrySelector(slug: string): EntrySelector\n\n models(): ModelSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n StarlightClient & {\n [K in keyof T]: EntrySelector<T[K]>\n }\n\nexport interface StarlightItemResponse<T> {\n data: T\n}\n\nexport interface StarlightListResponse<T> {\n data: T[]\n links: {\n first: string\n last: string\n prev?: string\n next?: string\n }\n meta: {\n current_page: number\n last_page: number\n from: number\n to: number\n per_page: number\n total: number\n }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\nexport interface WorkspaceModelDefinition {\n [slug: string]: SerializedData\n}\n"]}
|
package/dist/types/visual.d.ts
CHANGED
|
@@ -1,10 +1,29 @@
|
|
|
1
|
-
|
|
1
|
+
interface BlockData {
|
|
2
|
+
[key: string]: unknown;
|
|
3
|
+
}
|
|
4
|
+
export interface ParagraphBlock extends BlockData {
|
|
5
|
+
text: string;
|
|
6
|
+
}
|
|
7
|
+
export interface HeaderBlock extends BlockData {
|
|
8
|
+
text: string;
|
|
9
|
+
level: number;
|
|
10
|
+
}
|
|
11
|
+
export interface QuoteBlock extends BlockData {
|
|
12
|
+
text: string;
|
|
13
|
+
caption: string;
|
|
14
|
+
alignment: 'left' | 'center';
|
|
15
|
+
}
|
|
16
|
+
export interface ImageBlock extends BlockData {
|
|
17
|
+
url: string;
|
|
18
|
+
}
|
|
19
|
+
export interface VisualDataBlock<D extends BlockData = BlockData> {
|
|
2
20
|
type: string;
|
|
3
21
|
data: D;
|
|
4
22
|
}
|
|
5
23
|
export interface VisualData {
|
|
6
24
|
time?: number;
|
|
7
25
|
version?: string;
|
|
8
|
-
blocks:
|
|
26
|
+
blocks: VisualDataBlock[];
|
|
9
27
|
}
|
|
28
|
+
export {};
|
|
10
29
|
//# sourceMappingURL=visual.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,
|
|
1
|
+
{"version":3,"file":"visual.d.ts","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"AAAA,UAAU,SAAS;IACjB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC7B;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS;IAC9D,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;CACR;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,eAAe,EAAE,CAAA;CAC1B"}
|
package/dist/types/visual.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["
|
|
1
|
+
{"version":3,"file":"visual.js","sourceRoot":"","sources":["../../src/types/visual.ts"],"names":[],"mappings":"","sourcesContent":["interface BlockData {\n [key: string]: unknown\n}\n\nexport interface ParagraphBlock extends BlockData {\n text: string\n}\n\nexport interface HeaderBlock extends BlockData {\n text: string\n level: number\n}\n\nexport interface QuoteBlock extends BlockData {\n text: string\n caption: string\n alignment: 'left' | 'center'\n}\n\nexport interface ImageBlock extends BlockData {\n url: string\n}\n\nexport interface VisualDataBlock<D extends BlockData = BlockData> {\n type: string\n data: D\n}\n\nexport interface VisualData {\n time?: number\n version?: string\n blocks: VisualDataBlock[]\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@starlightcms/js-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.3",
|
|
4
4
|
"description": "The Starlight SDK for JavaScript",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
7
|
-
"build": "tsc",
|
|
7
|
+
"build": "rimraf dist && tsc",
|
|
8
8
|
"dev": "tsc --watch",
|
|
9
9
|
"prepare": "husky install",
|
|
10
10
|
"prepublishOnly": "npm run build",
|
|
@@ -36,7 +36,8 @@
|
|
|
36
36
|
"husky": "^7.0.2",
|
|
37
37
|
"lint-staged": "^11.1.2",
|
|
38
38
|
"prettier": "2.4.1",
|
|
39
|
-
"typescript": "^4.4.3"
|
|
39
|
+
"typescript": "^4.4.3",
|
|
40
|
+
"rimraf": "^3.0.2"
|
|
40
41
|
},
|
|
41
42
|
"lint-staged": {
|
|
42
43
|
"*.{ts}": [
|
package/dist/types.d.ts
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
import EntrySelector from './selectors/EntrySelector';
|
|
2
|
-
import ModelSelector from './selectors/ModelSelector';
|
|
3
|
-
declare type BaseUrl = 'https://query.starlight.sh/v2' | string;
|
|
4
|
-
export declare type StarlightConfig = {
|
|
5
|
-
workspace?: string;
|
|
6
|
-
baseUrl?: BaseUrl;
|
|
7
|
-
debug?: boolean;
|
|
8
|
-
};
|
|
9
|
-
export interface StarlightClient {
|
|
10
|
-
configure(config: StarlightConfig): void;
|
|
11
|
-
log(message?: unknown, ...optionalParams: unknown[]): void;
|
|
12
|
-
getBaseUrl(): string;
|
|
13
|
-
get<T = Record<string, unknown>>(path: string, options?: RequestInit): Promise<T>;
|
|
14
|
-
getEntrySelector(slug: string): EntrySelector;
|
|
15
|
-
models(): ModelSelector;
|
|
16
|
-
}
|
|
17
|
-
export declare type ProxiedStarlightClient<T extends WorkspaceModelDefinition> = StarlightClient & {
|
|
18
|
-
[K in keyof T]: EntrySelector<T[K]>;
|
|
19
|
-
};
|
|
20
|
-
export declare type StarlightItem<T> = {
|
|
21
|
-
data: T;
|
|
22
|
-
};
|
|
23
|
-
export declare type StarlightList<T> = {
|
|
24
|
-
data: T[];
|
|
25
|
-
links: {
|
|
26
|
-
first: string;
|
|
27
|
-
last: string;
|
|
28
|
-
prev?: string;
|
|
29
|
-
next?: string;
|
|
30
|
-
};
|
|
31
|
-
meta: {
|
|
32
|
-
current_page: number;
|
|
33
|
-
last_page: number;
|
|
34
|
-
from: number;
|
|
35
|
-
to: number;
|
|
36
|
-
per_page: number;
|
|
37
|
-
total: number;
|
|
38
|
-
};
|
|
39
|
-
};
|
|
40
|
-
interface StarlightEntity {
|
|
41
|
-
id: number;
|
|
42
|
-
created_at: string;
|
|
43
|
-
updated_at?: string;
|
|
44
|
-
}
|
|
45
|
-
export interface Model extends StarlightEntity {
|
|
46
|
-
title: string;
|
|
47
|
-
slug: string;
|
|
48
|
-
entry_count?: number;
|
|
49
|
-
}
|
|
50
|
-
interface Author {
|
|
51
|
-
id: number;
|
|
52
|
-
name: string;
|
|
53
|
-
}
|
|
54
|
-
interface ModelCategory extends StarlightEntity {
|
|
55
|
-
title: string;
|
|
56
|
-
slug: string;
|
|
57
|
-
}
|
|
58
|
-
export interface DefaultModelDefinition extends WorkspaceModelDefinition {
|
|
59
|
-
}
|
|
60
|
-
export interface WorkspaceModelDefinition {
|
|
61
|
-
[slug: string]: EntryData;
|
|
62
|
-
}
|
|
63
|
-
export declare type EntryData = Record<string, unknown> | undefined;
|
|
64
|
-
export interface Entry<D extends EntryData = undefined> extends Omit<StarlightEntity, 'created_at'> {
|
|
65
|
-
title: string;
|
|
66
|
-
slug: string;
|
|
67
|
-
data: D;
|
|
68
|
-
author: Author;
|
|
69
|
-
category: ModelCategory | null;
|
|
70
|
-
model?: Model;
|
|
71
|
-
published_at: string | null;
|
|
72
|
-
}
|
|
73
|
-
export {};
|
|
74
|
-
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,2BAA2B,CAAA;AACrD,OAAO,aAAa,MAAM,2BAA2B,CAAA;AAErD,aAAK,OAAO,GAAG,+BAA+B,GAAG,MAAM,CAAA;AAEvD,oBAAY,eAAe,GAAG;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB,CAAA;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAA;IAExC,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAE1D,UAAU,IAAI,MAAM,CAAA;IAEpB,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC,CAAA;IAEb,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,CAAA;IAE7C,MAAM,IAAI,aAAa,CAAA;CACxB;AAED,oBAAY,sBAAsB,CAAC,CAAC,SAAS,wBAAwB,IACnE,eAAe,GAAG;KACf,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACpC,CAAA;AAEH,oBAAY,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,CAAC,CAAA;CACR,CAAA;AAED,oBAAY,aAAa,CAAC,CAAC,IAAI;IAC7B,IAAI,EAAE,CAAC,EAAE,CAAA;IACT,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;KACd,CAAA;IACD,IAAI,EAAE;QACJ,YAAY,EAAE,MAAM,CAAA;QACpB,SAAS,EAAE,MAAM,CAAA;QACjB,IAAI,EAAE,MAAM,CAAA;QACZ,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;CACF,CAAA;AAED,UAAU,eAAe;IACvB,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,KAAM,SAAQ,eAAe;IAC5C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,UAAU,MAAM;IACd,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,UAAU,aAAc,SAAQ,eAAe;IAC7C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb;AAGD,MAAM,WAAW,sBAAuB,SAAQ,wBAAwB;CAAG;AAE3E,MAAM,WAAW,wBAAwB;IACvC,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;CAC1B;AAED,oBAAY,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;AAE3D,MAAM,WAAW,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CACpD,SAAQ,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,CAAC,CAAA;IACP,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAA;IAC9B,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B"}
|
package/dist/types.js
DELETED
package/dist/types.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"","sourcesContent":["import EntrySelector from './selectors/EntrySelector'\nimport ModelSelector from './selectors/ModelSelector'\n\ntype BaseUrl = 'https://query.starlight.sh/v2' | string\n\nexport type StarlightConfig = {\n workspace?: string\n baseUrl?: BaseUrl\n debug?: boolean\n}\n\nexport interface StarlightClient {\n configure(config: StarlightConfig): void\n\n log(message?: unknown, ...optionalParams: unknown[]): void\n\n getBaseUrl(): string\n\n get<T = Record<string, unknown>>(\n path: string,\n options?: RequestInit\n ): Promise<T>\n\n getEntrySelector(slug: string): EntrySelector\n\n models(): ModelSelector\n}\n\nexport type ProxiedStarlightClient<T extends WorkspaceModelDefinition> =\n StarlightClient & {\n [K in keyof T]: EntrySelector<T[K]>\n }\n\nexport type StarlightItem<T> = {\n data: T\n}\n\nexport type StarlightList<T> = {\n data: T[]\n links: {\n first: string\n last: string\n prev?: string\n next?: string\n }\n meta: {\n current_page: number\n last_page: number\n from: number\n to: number\n per_page: number\n total: number\n }\n}\n\ninterface StarlightEntity {\n id: number\n created_at: string\n updated_at?: string\n}\n\nexport interface Model extends StarlightEntity {\n title: string\n slug: string\n entry_count?: number\n}\n\ninterface Author {\n id: number\n name: string\n}\n\ninterface ModelCategory extends StarlightEntity {\n title: string\n slug: string\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-interface\nexport interface DefaultModelDefinition extends WorkspaceModelDefinition {}\n\nexport interface WorkspaceModelDefinition {\n [slug: string]: EntryData\n}\n\nexport type EntryData = Record<string, unknown> | undefined\n\nexport interface Entry<D extends EntryData = undefined>\n extends Omit<StarlightEntity, 'created_at'> {\n title: string\n slug: string\n data: D\n author: Author\n category: ModelCategory | null\n model?: Model\n published_at: string | null\n}\n"]}
|