@raster-app/sdk 0.1.0-canary-2e1834e

package/dist/images/sizes.d.ts

@@ -0,0 +1,15 @@
+/**
+ * An asset's `sizes`, parsed: each size, the longest edge in pixels as a string such as `"400"`,
+ * maps to the CDN URL of the image at that size. Only sizes smaller than the source exist.
+ */
+export type SizeUrls = Record<string, string>;
+/**
+ * Parse an asset's JSON-encoded `sizes`. Null when they are absent or malformed, so callers
+ * fall back to the full-size `url`.
+ */
+export declare function parseSizes(sizes: string | null | undefined): SizeUrls | null;
+/**
+ * The URL of the smallest size at or above `targetEdge`, or of the largest when none reaches
+ * it. Null when there are no sizes.
+ */
+export declare function pickSizeUrl(sizes: SizeUrls | null | undefined, targetEdge: number): string | null;

package/dist/images/sizes.js

@@ -0,0 +1,41 @@
+/**
+ * Parse an asset's JSON-encoded `sizes`. Null when they are absent or malformed, so callers
+ * fall back to the full-size `url`.
+ */
+export function parseSizes(sizes) {
+    if (!sizes)
+        return null;
+    try {
+        const parsed = JSON.parse(sizes);
+        if (typeof parsed !== 'object' || parsed === null)
+            return null;
+        const map = {};
+        for (const [size, url] of Object.entries(parsed)) {
+            if (typeof url === 'string')
+                map[size] = url;
+        }
+        return map;
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * The URL of the smallest size at or above `targetEdge`, or of the largest when none reaches
+ * it. Null when there are no sizes.
+ */
+export function pickSizeUrl(sizes, targetEdge) {
+    if (!sizes)
+        return null;
+    const available = Object.keys(sizes)
+        .map(Number)
+        .filter((n) => Number.isFinite(n))
+        .sort((a, b) => a - b);
+    if (available.length === 0)
+        return null;
+    const chosen = available.find((n) => n >= targetEdge) ?? available[available.length - 1];
+    if (chosen === undefined)
+        return null;
+    return sizes[String(chosen)] ?? null;
+}
+//# sourceMappingURL=sizes.js.map

package/dist/images/sizes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sizes.js","sourceRoot":"","sources":["../../src/images/sizes.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAgC;IAC1D,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IACvB,IAAI,CAAC;QACJ,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACzC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;YAAE,OAAO,IAAI,CAAA;QAC9D,MAAM,GAAG,GAAa,EAAE,CAAA;QACxB,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAA;QAC7C,CAAC;QACD,OAAO,GAAG,CAAA;IACX,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,IAAI,CAAA;IACZ,CAAC;AACF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,KAAkC,EAAE,UAAkB;IACjF,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAA;IACvB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;SAClC,GAAG,CAAC,MAAM,CAAC;SACX,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SACjC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;IACvB,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAA;IACvC,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IACxF,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,IAAI,CAAA;IACrC,OAAO,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,IAAI,CAAA;AACrC,CAAC","sourcesContent":["/**\n * An asset's `sizes`, parsed: each size, the longest edge in pixels as a string such as `\"400\"`,\n * maps to the CDN URL of the image at that size. Only sizes smaller than the source exist.\n */\nexport type SizeUrls = Record<string, string>\n\n/**\n * Parse an asset's JSON-encoded `sizes`. Null when they are absent or malformed, so callers\n * fall back to the full-size `url`.\n */\nexport function parseSizes(sizes: string | null | undefined): SizeUrls | null {\n\tif (!sizes) return null\n\ttry {\n\t\tconst parsed: unknown = JSON.parse(sizes)\n\t\tif (typeof parsed !== 'object' || parsed === null) return null\n\t\tconst map: SizeUrls = {}\n\t\tfor (const [size, url] of Object.entries(parsed)) {\n\t\t\tif (typeof url === 'string') map[size] = url\n\t\t}\n\t\treturn map\n\t} catch {\n\t\treturn null\n\t}\n}\n\n/**\n * The URL of the smallest size at or above `targetEdge`, or of the largest when none reaches\n * it. Null when there are no sizes.\n */\nexport function pickSizeUrl(sizes: SizeUrls | null | undefined, targetEdge: number): string | null {\n\tif (!sizes) return null\n\tconst available = Object.keys(sizes)\n\t\t.map(Number)\n\t\t.filter((n) => Number.isFinite(n))\n\t\t.sort((a, b) => a - b)\n\tif (available.length === 0) return null\n\tconst chosen = available.find((n) => n >= targetEdge) ?? available[available.length - 1]\n\tif (chosen === undefined) return null\n\treturn sizes[String(chosen)] ?? null\n}\n"]}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+export { type RasterClient, type RasterClientConfig, createRasterClient } from './client.js';
+export type { CredentialStore, RasterHost } from './adapters/index.js';
+export { localStorageCredentialStore } from './adapters/local-storage.js';
+export { memoryCredentialStore } from './adapters/memory.js';
+export { RasterApiError, isAbortError, toFetchError, toRasterApiError, toUserMessage, } from './api/errors.js';
+export { API_ORIGIN, API_VERSION, AUTH_ORIGIN, RASTER_HOSTS } from './constants.js';
+export { type Asset, type AssetVariant, type DisplayAsset, type UploadedAsset, type Uploader, isReady, } from './types/asset.js';
+export type { Library, Organization, Tag } from './types/library.js';
+export { type CredentialOrganization, type OAuthSession, type StoredCredentials, SIGNED_OUT, emptyCredentials, isConfigured, } from './types/session.js';
+export type { SessionStore } from './auth/session.js';
+export type { DeviceAuthorization } from './auth/device.js';
+export { ASSETS_PAGE_SIZE, hasMorePages } from './api/assets.js';
+export { LIBRARIES_PAGE_SIZE } from './api/libraries.js';
+export { SEARCH_PAGE_SIZE, type SearchHit, type SearchResult } from './api/search.js';
+export type { PromoteResult } from './api/promote.js';
+export type { UploadSource } from './api/upload.js';
+export { type Me, type MeLibraryAccess, type MeOrganization, meCredentialOrganizations, meLibraryAccess, meOrganizationList, meOrganizations, } from './api/me.js';
+export type { AuthorizedInit, RequestOptions, Transport } from './api/transport.js';
+export { decodeBlurhash } from './images/blurhash.js';
+export { blurhashToDataUrl } from './images/blurhash-placeholder.js';
+export { getBlurhashPlaceholder, getFullSizeUrl, getPreviewUrl, getThumbUrl, versionedUrl, } from './images/image-src.js';
+export { type SizeUrls, parseSizes, pickSizeUrl } from './images/sizes.js';
+export { formatBytes, formatDate, formatDateLong, formatFileSize, formatRelativeTime, } from './format.js';

package/dist/index.js

@@ -0,0 +1,17 @@
+export { createRasterClient } from './client.js';
+export { localStorageCredentialStore } from './adapters/local-storage.js';
+export { memoryCredentialStore } from './adapters/memory.js';
+export { RasterApiError, isAbortError, toFetchError, toRasterApiError, toUserMessage, } from './api/errors.js';
+export { API_ORIGIN, API_VERSION, AUTH_ORIGIN, RASTER_HOSTS } from './constants.js';
+export { isReady, } from './types/asset.js';
+export { SIGNED_OUT, emptyCredentials, isConfigured, } from './types/session.js';
+export { ASSETS_PAGE_SIZE, hasMorePages } from './api/assets.js';
+export { LIBRARIES_PAGE_SIZE } from './api/libraries.js';
+export { SEARCH_PAGE_SIZE } from './api/search.js';
+export { meCredentialOrganizations, meLibraryAccess, meOrganizationList, meOrganizations, } from './api/me.js';
+export { decodeBlurhash } from './images/blurhash.js';
+export { blurhashToDataUrl } from './images/blurhash-placeholder.js';
+export { getBlurhashPlaceholder, getFullSizeUrl, getPreviewUrl, getThumbUrl, versionedUrl, } from './images/image-src.js';
+export { parseSizes, pickSizeUrl } from './images/sizes.js';
+export { formatBytes, formatDate, formatDateLong, formatFileSize, formatRelativeTime, } from './format.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8C,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAG5F,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AACzE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAE5D,OAAO,EACN,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,aAAa,GACb,MAAM,iBAAiB,CAAA;AAExB,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAEnF,OAAO,EAMN,OAAO,GACP,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EAIN,UAAU,EACV,gBAAgB,EAChB,YAAY,GACZ,MAAM,oBAAoB,CAAA;AAK3B,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,gBAAgB,EAAqC,MAAM,iBAAiB,CAAA;AAGrF,OAAO,EAIN,yBAAyB,EACzB,eAAe,EACf,kBAAkB,EAClB,eAAe,GACf,MAAM,aAAa,CAAA;AAGpB,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAA;AACpE,OAAO,EACN,sBAAsB,EACtB,cAAc,EACd,aAAa,EACb,WAAW,EACX,YAAY,GACZ,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAiB,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAE1E,OAAO,EACN,WAAW,EACX,UAAU,EACV,cAAc,EACd,cAAc,EACd,kBAAkB,GAClB,MAAM,aAAa,CAAA","sourcesContent":["export { type RasterClient, type RasterClientConfig, createRasterClient } from './client.js'\n\nexport type { CredentialStore, RasterHost } from './adapters/index.js'\nexport { localStorageCredentialStore } from './adapters/local-storage.js'\nexport { memoryCredentialStore } from './adapters/memory.js'\n\nexport {\n\tRasterApiError,\n\tisAbortError,\n\ttoFetchError,\n\ttoRasterApiError,\n\ttoUserMessage,\n} from './api/errors.js'\n\nexport { API_ORIGIN, API_VERSION, AUTH_ORIGIN, RASTER_HOSTS } from './constants.js'\n\nexport {\n\ttype Asset,\n\ttype AssetVariant,\n\ttype DisplayAsset,\n\ttype UploadedAsset,\n\ttype Uploader,\n\tisReady,\n} from './types/asset.js'\nexport type { Library, Organization, Tag } from './types/library.js'\nexport {\n\ttype CredentialOrganization,\n\ttype OAuthSession,\n\ttype StoredCredentials,\n\tSIGNED_OUT,\n\temptyCredentials,\n\tisConfigured,\n} from './types/session.js'\n\nexport type { SessionStore } from './auth/session.js'\nexport type { DeviceAuthorization } from './auth/device.js'\n\nexport { ASSETS_PAGE_SIZE, hasMorePages } from './api/assets.js'\nexport { LIBRARIES_PAGE_SIZE } from './api/libraries.js'\nexport { SEARCH_PAGE_SIZE, type SearchHit, type SearchResult } from './api/search.js'\nexport type { PromoteResult } from './api/promote.js'\nexport type { UploadSource } from './api/upload.js'\nexport {\n\ttype Me,\n\ttype MeLibraryAccess,\n\ttype MeOrganization,\n\tmeCredentialOrganizations,\n\tmeLibraryAccess,\n\tmeOrganizationList,\n\tmeOrganizations,\n} from './api/me.js'\nexport type { AuthorizedInit, RequestOptions, Transport } from './api/transport.js'\n\nexport { decodeBlurhash } from './images/blurhash.js'\nexport { blurhashToDataUrl } from './images/blurhash-placeholder.js'\nexport {\n\tgetBlurhashPlaceholder,\n\tgetFullSizeUrl,\n\tgetPreviewUrl,\n\tgetThumbUrl,\n\tversionedUrl,\n} from './images/image-src.js'\nexport { type SizeUrls, parseSizes, pickSizeUrl } from './images/sizes.js'\n\nexport {\n\tformatBytes,\n\tformatDate,\n\tformatDateLong,\n\tformatFileSize,\n\tformatRelativeTime,\n} from './format.js'\n"]}

package/dist/types/asset.d.ts

@@ -0,0 +1,50 @@
+import type { components } from '../__generated__/openapi.js';
+/** A non-destructive variant of an asset — a crop, a colour adjustment. */
+export type AssetVariant = components['schemas']['AssetVariant'];
+export type Uploader = components['schemas']['Uploader'];
+export type Asset = components['schemas']['Asset'];
+/** The subset a grid renders, which `Asset` and `AssetVariant` both satisfy. */
+export type DisplayAsset = {
+    id: string;
+    name: string | null;
+    url: string | null;
+    sizes: string | null;
+    width: number | null;
+    height: number | null;
+    blurhash?: string | null;
+    /** Absent on an `AssetVariant`, whose URL is content-addressed (see `versionedUrl`). */
+    contentVersion?: number | null;
+    /**
+     * Client-only: an optimistic promote sets these to the promoted variant's own image, and
+     * keeps `url` and `sizes`, which variant URLs are built from. The URL helpers prefer them.
+     */
+    displayUrl?: string | null;
+    displaySizes?: string | null;
+    /**
+     * Client-only: set on the optimistic placeholder for a just-uploaded variant, which has the
+     * source's dimensions but is not selectable until Raster has produced the image.
+     */
+    processing?: boolean;
+    contentType?: string | null;
+    size?: number | null;
+    variants?: Asset['variants'];
+};
+/**
+ * Whether Raster has finished processing an asset or variant. Processing writes the
+ * dimensions when it finishes, for every image and video. It never writes `sizes` for an SVG
+ * or a small image, or `blurhash` for an SVG, and a listed variant has no `blurhash` at all.
+ * Zero means Raster could not read the file, which leaves nothing to place.
+ */
+export declare function isProcessed(asset: {
+    width?: number | null;
+    height?: number | null;
+}): boolean;
+/**
+ * An asset is usable once it has a full-size image (`getFullSizeUrl`) and is not processing.
+ * Its url exists from the upload on, so it is the dimensions or sizes, which processing
+ * writes when it finishes, that tell. A search hit has sizes but no url, and its index
+ * may never have stored dimensions: a host takes those from the loaded image.
+ */
+export declare function isReady(asset: DisplayAsset): boolean;
+/** The asset an upload created. `appUrl` opens it in Raster. */
+export type UploadedAsset = Pick<Asset, 'id' | 'parentId' | 'url' | 'appUrl' | 'name'>;

package/dist/types/asset.js

@@ -0,0 +1,23 @@
+import { getFullSizeUrl } from '../images/image-src.js';
+import { parseSizes } from '../images/sizes.js';
+/**
+ * Whether Raster has finished processing an asset or variant. Processing writes the
+ * dimensions when it finishes, for every image and video. It never writes `sizes` for an SVG
+ * or a small image, or `blurhash` for an SVG, and a listed variant has no `blurhash` at all.
+ * Zero means Raster could not read the file, which leaves nothing to place.
+ */
+export function isProcessed(asset) {
+    return (asset.width ?? 0) > 0 && (asset.height ?? 0) > 0;
+}
+/**
+ * An asset is usable once it has a full-size image (`getFullSizeUrl`) and is not processing.
+ * Its url exists from the upload on, so it is the dimensions or sizes, which processing
+ * writes when it finishes, that tell. A search hit has sizes but no url, and its index
+ * may never have stored dimensions: a host takes those from the loaded image.
+ */
+export function isReady(asset) {
+    return (!asset.processing &&
+        getFullSizeUrl(asset) !== null &&
+        (isProcessed(asset) || parseSizes(asset.sizes) !== null));
+}
+//# sourceMappingURL=asset.js.map

package/dist/types/asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.js","sourceRoot":"","sources":["../../src/types/asset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAoC/C;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,KAAwD;IACnF,OAAO,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;AACzD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAmB;IAC1C,OAAO,CACN,CAAC,KAAK,CAAC,UAAU;QACjB,cAAc,CAAC,KAAK,CAAC,KAAK,IAAI;QAC9B,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CACxD,CAAA;AACF,CAAC","sourcesContent":["import type { components } from '../__generated__/openapi.js'\nimport { getFullSizeUrl } from '../images/image-src.js'\nimport { parseSizes } from '../images/sizes.js'\n\n/** A non-destructive variant of an asset — a crop, a colour adjustment. */\nexport type AssetVariant = components['schemas']['AssetVariant']\n\nexport type Uploader = components['schemas']['Uploader']\n\nexport type Asset = components['schemas']['Asset']\n\n/** The subset a grid renders, which `Asset` and `AssetVariant` both satisfy. */\nexport type DisplayAsset = {\n\tid: string\n\tname: string | null\n\turl: string | null\n\tsizes: string | null\n\twidth: number | null\n\theight: number | null\n\tblurhash?: string | null\n\t/** Absent on an `AssetVariant`, whose URL is content-addressed (see `versionedUrl`). */\n\tcontentVersion?: number | null\n\t/**\n\t * Client-only: an optimistic promote sets these to the promoted variant's own image, and\n\t * keeps `url` and `sizes`, which variant URLs are built from. The URL helpers prefer them.\n\t */\n\tdisplayUrl?: string | null\n\tdisplaySizes?: string | null\n\t/**\n\t * Client-only: set on the optimistic placeholder for a just-uploaded variant, which has the\n\t * source's dimensions but is not selectable until Raster has produced the image.\n\t */\n\tprocessing?: boolean\n\tcontentType?: string | null\n\tsize?: number | null\n\tvariants?: Asset['variants']\n}\n\n/**\n * Whether Raster has finished processing an asset or variant. Processing writes the\n * dimensions when it finishes, for every image and video. It never writes `sizes` for an SVG\n * or a small image, or `blurhash` for an SVG, and a listed variant has no `blurhash` at all.\n * Zero means Raster could not read the file, which leaves nothing to place.\n */\nexport function isProcessed(asset: { width?: number | null; height?: number | null }): boolean {\n\treturn (asset.width ?? 0) > 0 && (asset.height ?? 0) > 0\n}\n\n/**\n * An asset is usable once it has a full-size image (`getFullSizeUrl`) and is not processing.\n * Its url exists from the upload on, so it is the dimensions or sizes, which processing\n * writes when it finishes, that tell. A search hit has sizes but no url, and its index\n * may never have stored dimensions: a host takes those from the loaded image.\n */\nexport function isReady(asset: DisplayAsset): boolean {\n\treturn (\n\t\t!asset.processing &&\n\t\tgetFullSizeUrl(asset) !== null &&\n\t\t(isProcessed(asset) || parseSizes(asset.sizes) !== null)\n\t)\n}\n\n/** The asset an upload created. `appUrl` opens it in Raster. */\nexport type UploadedAsset = Pick<Asset, 'id' | 'parentId' | 'url' | 'appUrl' | 'name'>\n"]}

package/dist/types/library.d.ts

@@ -0,0 +1,21 @@
+import type { components } from '../__generated__/openapi.js';
+/**
+ * An organization the credential can act on. `/me` reports these, so a host knows the set
+ * before fetching a single library — which is what lets it offer a choice first.
+ */
+export type Organization = {
+    id: string;
+    name: string | null;
+    /** Libraries reachable here. Carried by `/me`, so showing it costs no extra request. */
+    libraryCount: number;
+};
+export type Tag = components['schemas']['Tag'];
+export type Library = components['schemas']['Library'] & {
+    /**
+     * The organization this library came from, which the SDK attaches: a credential can reach
+     * several, and every request for this library's assets needs it in the path.
+     */
+    organizationId: string;
+    /** For display when a credential spans several organizations. */
+    organizationName: string | null;
+};

package/dist/types/library.js

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

package/dist/types/library.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"library.js","sourceRoot":"","sources":["../../src/types/library.ts"],"names":[],"mappings":"","sourcesContent":["import type { components } from '../__generated__/openapi.js'\n\n/**\n * An organization the credential can act on. `/me` reports these, so a host knows the set\n * before fetching a single library — which is what lets it offer a choice first.\n */\nexport type Organization = {\n\tid: string\n\tname: string | null\n\t/** Libraries reachable here. Carried by `/me`, so showing it costs no extra request. */\n\tlibraryCount: number\n}\n\nexport type Tag = components['schemas']['Tag']\n\nexport type Library = components['schemas']['Library'] & {\n\t/**\n\t * The organization this library came from, which the SDK attaches: a credential can reach\n\t * several, and every request for this library's assets needs it in the path.\n\t */\n\torganizationId: string\n\t/** For display when a credential spans several organizations. */\n\torganizationName: string | null\n}\n"]}

package/dist/types/session.d.ts

@@ -0,0 +1,59 @@
+/** A signed-in session — what the device grant hands back. */
+export type OAuthSession = {
+    /** The install's client_id, which every sign-in through it reuses; refreshes present it. */
+    clientId: string;
+    /**
+     * Names this sign-in: minted when `connect` adopts it, kept through every refresh. The
+     * client id cannot do this, because the next sign-in reuses it. Absent from a session
+     * saved before this field existed.
+     */
+    signInId?: string;
+    accessToken: string;
+    /**
+     * Rotates on every refresh, and presenting a spent one revokes the whole connection — so
+     * this is always the latest one issued, saved the moment it arrives.
+     */
+    refreshToken: string;
+    /** When `accessToken` stops being accepted, in epoch ms. */
+    expiresAt: number;
+};
+/** One organization the credential reaches, as resolved from `/me`. */
+export type CredentialOrganization = {
+    id: string;
+    name: string | null;
+};
+/**
+ * Everything the SDK persists through a `CredentialStore`, as one object written at once, so
+ * a crash cannot leave a session half-saved.
+ */
+export type StoredCredentials = {
+    /**
+     * The OAuth client this install registered, kept across sign-outs, so Connected apps lists
+     * one entry per install rather than one per sign-in.
+     */
+    clientId: string | null;
+    /** A pasted organization API key — the alternative to signing in. Null when signed in. */
+    apiKey: string | null;
+    /** The signed-in session. Null when using an API key, or signed out. */
+    oauth: OAuthSession | null;
+    /**
+     * The person signed in, for "Signed in as …". Null for the API-key path — a key belongs
+     * to an organization, not a person — and null until `/me` reports the account's name.
+     */
+    userName: string | null;
+    /**
+     * Every organization the credential reaches. One entry for an API key, or for a sign-in
+     * the user narrowed to a single organization at consent; several when they granted all
+     * of them. Empty only when the account belongs to none.
+     */
+    organizations: Array<CredentialOrganization>;
+};
+/** Signed out, but still holding the registration — see `StoredCredentials.clientId`. */
+export declare const SIGNED_OUT: Omit<StoredCredentials, 'clientId'>;
+/** Empty credentials, as a store returns before anything has ever been saved. */
+export declare function emptyCredentials(): StoredCredentials;
+/**
+ * Whether these credentials can call the API at all. An account in no organization is signed
+ * in, and its host shows an empty list.
+ */
+export declare function isConfigured(credentials: StoredCredentials | null | undefined): credentials is StoredCredentials;

package/dist/types/session.js

@@ -0,0 +1,21 @@
+/** Signed out, but still holding the registration — see `StoredCredentials.clientId`. */
+export const SIGNED_OUT = {
+    apiKey: null,
+    oauth: null,
+    userName: null,
+    organizations: [],
+};
+/** Empty credentials, as a store returns before anything has ever been saved. */
+export function emptyCredentials() {
+    return { ...SIGNED_OUT, clientId: null };
+}
+/**
+ * Whether these credentials can call the API at all. An account in no organization is signed
+ * in, and its host shows an empty list.
+ */
+export function isConfigured(credentials) {
+    return (credentials != null &&
+        (credentials.oauth !== null ||
+            (typeof credentials.apiKey === 'string' && credentials.apiKey !== '')));
+}
+//# sourceMappingURL=session.js.map

package/dist/types/session.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session.js","sourceRoot":"","sources":["../../src/types/session.ts"],"names":[],"mappings":"AAqDA,yFAAyF;AACzF,MAAM,CAAC,MAAM,UAAU,GAAwC;IAC9D,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,EAAE;CACjB,CAAA;AAED,iFAAiF;AACjF,MAAM,UAAU,gBAAgB;IAC/B,OAAO,EAAE,GAAG,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAC3B,WAAiD;IAEjD,OAAO,CACN,WAAW,IAAI,IAAI;QACnB,CAAC,WAAW,CAAC,KAAK,KAAK,IAAI;YAC1B,CAAC,OAAO,WAAW,CAAC,MAAM,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CACvE,CAAA;AACF,CAAC","sourcesContent":["/** A signed-in session — what the device grant hands back. */\nexport type OAuthSession = {\n\t/** The install's client_id, which every sign-in through it reuses; refreshes present it. */\n\tclientId: string\n\t/**\n\t * Names this sign-in: minted when `connect` adopts it, kept through every refresh. The\n\t * client id cannot do this, because the next sign-in reuses it. Absent from a session\n\t * saved before this field existed.\n\t */\n\tsignInId?: string\n\taccessToken: string\n\t/**\n\t * Rotates on every refresh, and presenting a spent one revokes the whole connection — so\n\t * this is always the latest one issued, saved the moment it arrives.\n\t */\n\trefreshToken: string\n\t/** When `accessToken` stops being accepted, in epoch ms. */\n\texpiresAt: number\n}\n\n/** One organization the credential reaches, as resolved from `/me`. */\nexport type CredentialOrganization = {\n\tid: string\n\tname: string | null\n}\n\n/**\n * Everything the SDK persists through a `CredentialStore`, as one object written at once, so\n * a crash cannot leave a session half-saved.\n */\nexport type StoredCredentials = {\n\t/**\n\t * The OAuth client this install registered, kept across sign-outs, so Connected apps lists\n\t * one entry per install rather than one per sign-in.\n\t */\n\tclientId: string | null\n\t/** A pasted organization API key — the alternative to signing in. Null when signed in. */\n\tapiKey: string | null\n\t/** The signed-in session. Null when using an API key, or signed out. */\n\toauth: OAuthSession | null\n\t/**\n\t * The person signed in, for \"Signed in as …\". Null for the API-key path — a key belongs\n\t * to an organization, not a person — and null until `/me` reports the account's name.\n\t */\n\tuserName: string | null\n\t/**\n\t * Every organization the credential reaches. One entry for an API key, or for a sign-in\n\t * the user narrowed to a single organization at consent; several when they granted all\n\t * of them. Empty only when the account belongs to none.\n\t */\n\torganizations: Array<CredentialOrganization>\n}\n\n/** Signed out, but still holding the registration — see `StoredCredentials.clientId`. */\nexport const SIGNED_OUT: Omit<StoredCredentials, 'clientId'> = {\n\tapiKey: null,\n\toauth: null,\n\tuserName: null,\n\torganizations: [],\n}\n\n/** Empty credentials, as a store returns before anything has ever been saved. */\nexport function emptyCredentials(): StoredCredentials {\n\treturn { ...SIGNED_OUT, clientId: null }\n}\n\n/**\n * Whether these credentials can call the API at all. An account in no organization is signed\n * in, and its host shows an empty list.\n */\nexport function isConfigured(\n\tcredentials: StoredCredentials | null | undefined\n): credentials is StoredCredentials {\n\treturn (\n\t\tcredentials != null &&\n\t\t(credentials.oauth !== null ||\n\t\t\t(typeof credentials.apiKey === 'string' && credentials.apiKey !== ''))\n\t)\n}\n"]}

package/package.json

@@ -0,0 +1,42 @@
+{
+	"name": "@raster-app/sdk",
+	"version": "0.1.0-canary-2e1834e",
+	"description": "Framework-free client for the Raster REST API: OAuth, sessions, assets, libraries, search and image helpers.",
+	"license": "MIT",
+	"homepage": "https://raster.app/docs",
+	"keywords": [
+		"raster",
+		"dam",
+		"assets",
+		"figma",
+		"sanity",
+		"plugin"
+	],
+	"type": "module",
+	"sideEffects": false,
+	"files": [
+		"dist"
+	],
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		},
+		"./package.json": "./package.json"
+	},
+	"engines": {
+		"node": ">=24"
+	},
+	"scripts": {
+		"build": "rm -rf dist && tsc -p tsconfig.build.json",
+		"prepack": "bun run build",
+		"dev": "tsc -p tsconfig.build.json --watch",
+		"check-types": "tsc --noEmit",
+		"lint": "biome lint --error-on-warnings .",
+		"test": "bun test"
+	},
+	"publishConfig": {
+		"access": "public"
+	}
+}