scratch-storage 2.3.284 → 3.0.0

package/dist/types/Asset.d.ts

@@ -0,0 +1,38 @@
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+export type AssetId = string | number;
+export type AssetData = string | Uint8Array;
+export default class Asset {
+    assetType: AssetType;
+    assetId?: AssetId;
+    data?: AssetData;
+    dataFormat?: DataFormat;
+    dependencies: Asset[];
+    clean?: boolean;
+    /**
+     * Construct an Asset.
+     * @param {AssetType} assetType - The type of this asset (sound, image, etc.)
+     * @param {string} assetId - The ID of this asset.
+     * @param {DataFormat} [dataFormat] - The format of the data (WAV, PNG, etc.); required iff `data` is present.
+     * @param {Buffer} [data] - The in-memory data for this asset; optional.
+     * @param {bool} [generateId] - Whether to create id from an md5 hash of data
+     */
+    constructor(assetType: AssetType, assetId?: AssetId, dataFormat?: DataFormat, data?: AssetData, generateId?: boolean);
+    setData(data: AssetData | undefined, dataFormat: DataFormat | undefined, generateId?: boolean): void;
+    /**
+     * @returns {string} - This asset's data, decoded as text.
+     */
+    decodeText(): string;
+    /**
+     * Same as `setData` but encodes text first.
+     * @param {string} data - the text data to encode and store.
+     * @param {DataFormat} dataFormat - the format of the data (DataFormat.SVG for example).
+     * @param {bool} generateId - after setting data, set the id to an md5 of the data?
+     */
+    encodeTextData(data: string, dataFormat: DataFormat, generateId: boolean): void;
+    /**
+     * @param {string} [contentType] - Optionally override the content type to be included in the data URI.
+     * @returns {string} - A data URI representing the asset's data.
+     */
+    encodeDataURI(contentType: string): string;
+}

package/dist/types/AssetType.d.ts

@@ -0,0 +1,49 @@
+import { DataFormat } from './DataFormat';
+export interface AssetType {
+    contentType: string;
+    name: string;
+    runtimeFormat: DataFormat;
+    immutable: boolean;
+}
+/**
+ * Enumeration of the supported asset types.
+ * @type {Object.<String,AssetType>}
+ * @typedef {Object} AssetType - Information about a supported asset type.
+ * @property {string} contentType - the MIME type associated with this kind of data. Useful for data URIs, etc.
+ * @property {string} name - The human-readable name of this asset type.
+ * @property {DataFormat} runtimeFormat - The default format used for runtime, in-memory storage of this asset. For
+ *     example, a project stored in SB2 format on disk will be returned as JSON when loaded into memory.
+ * @property {boolean} immutable - Indicates if the asset id is determined by the asset content.
+ */
+export declare const AssetType: {
+    readonly ImageBitmap: {
+        readonly contentType: "image/png";
+        readonly name: "ImageBitmap";
+        readonly runtimeFormat: "png";
+        readonly immutable: true;
+    };
+    readonly ImageVector: {
+        readonly contentType: "image/svg+xml";
+        readonly name: "ImageVector";
+        readonly runtimeFormat: "svg";
+        readonly immutable: true;
+    };
+    readonly Project: {
+        readonly contentType: "application/json";
+        readonly name: "Project";
+        readonly runtimeFormat: "json";
+        readonly immutable: false;
+    };
+    readonly Sound: {
+        readonly contentType: "audio/x-wav";
+        readonly name: "Sound";
+        readonly runtimeFormat: "wav";
+        readonly immutable: true;
+    };
+    readonly Sprite: {
+        readonly contentType: "application/json";
+        readonly name: "Sprite";
+        readonly runtimeFormat: "json";
+        readonly immutable: true;
+    };
+};

package/dist/types/BuiltinHelper.d.ts

@@ -0,0 +1,69 @@
+import Asset, { AssetData, AssetId } from './Asset';
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+import Helper from './Helper';
+import { ScratchStorage } from './ScratchStorage';
+/**
+ * @typedef {object} BuiltinAssetRecord
+ * @property {AssetType} type - The type of the asset.
+ * @property {DataFormat} format - The format of the asset's data.
+ * @property {?string} id - The asset's unique ID.
+ * @property {Buffer} data - The asset's data.
+ */
+interface BuiltinAssetRecord {
+    type: AssetType;
+    format: DataFormat;
+    id: AssetId | null;
+    data: AssetData;
+}
+export default class BuiltinHelper extends Helper {
+    assets: Record<string, BuiltinAssetRecord>;
+    constructor(parent: ScratchStorage);
+    /**
+     * Call `setDefaultAssetId` on the parent `ScratchStorage` instance to register all built-in default assets.
+     */
+    registerDefaultAssets(): void;
+    /**
+     * Synchronously fetch a cached asset for a given asset id. Returns null if not found.
+     * @param {string} assetId - The id for the asset to fetch.
+     * @returns {?Asset} The asset for assetId, if it exists.
+     */
+    get(assetId: AssetId): Asset | null;
+    /**
+     * Alias for store (old name of store)
+     * @deprecated Use BuiltinHelper.store
+     * @param {AssetType} assetType - The type of the asset to cache.
+     * @param {DataFormat} dataFormat - The dataFormat of the data for the cached asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {string} id - The id for the cached asset.
+     * @returns {string} The calculated id of the cached asset, or the supplied id if the asset is mutable.
+     */
+    cache(assetType: AssetType, dataFormat: DataFormat, data: AssetData, id: AssetId): AssetId;
+    /**
+     * Deprecated external API for _store
+     * @deprecated Not for external use. Create assets and keep track of them outside of the storage instance.
+     * @param {AssetType} assetType - The type of the asset to cache.
+     * @param {DataFormat} dataFormat - The dataFormat of the data for the cached asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {(string|number)} id - The id for the cached asset.
+     * @returns {string} The calculated id of the cached asset, or the supplied id if the asset is mutable.
+     */
+    store(assetType: AssetType, dataFormat: DataFormat, data: AssetData, id: AssetId): AssetId;
+    /**
+     * Cache an asset for future lookups by ID.
+     * @param {AssetType} assetType - The type of the asset to cache.
+     * @param {DataFormat} dataFormat - The dataFormat of the data for the cached asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {(string|number)} id - The id for the cached asset.
+     * @returns {string} The calculated id of the cached asset, or the supplied id if the asset is mutable.
+     */
+    _store(assetType: AssetType, dataFormat: DataFormat, data: AssetData, id?: AssetId | null): AssetId;
+    /**
+     * Fetch an asset but don't process dependencies.
+     * @param {AssetType} assetType - The type of asset to fetch.
+     * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @return {?Promise.<Asset>} A promise for the contents of the asset.
+     */
+    load(assetType: AssetType, assetId: AssetId): Promise<Asset | null> | null;
+}
+export {};

package/dist/types/DataFormat.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Enumeration of the supported data formats.
+ * @enum {string}
+ */
+export declare const DataFormat: {
+    readonly JPG: "jpg";
+    readonly JSON: "json";
+    readonly MP3: "mp3";
+    readonly PNG: "png";
+    readonly SB2: "sb2";
+    readonly SB3: "sb3";
+    readonly SVG: "svg";
+    readonly WAV: "wav";
+};
+export type DataFormat = typeof DataFormat[keyof typeof DataFormat];

package/dist/types/FetchTool.d.ts

@@ -0,0 +1,33 @@
+import { ScratchGetRequest, ScratchSendRequest, Tool } from './Tool';
+/**
+ * @typedef {Request & {withCredentials: boolean}} ScratchSendRequest
+ */
+/**
+ * Get and send assets with the fetch standard web api.
+ */
+export declare class FetchTool implements Tool {
+    /**
+     * Is get supported?
+     * Always true for `FetchTool` because `scratchFetch` ponyfills `fetch` if necessary.
+     * @returns {boolean} Is get supported?
+     */
+    get isGetSupported(): boolean;
+    /**
+     * Request data from a server with fetch.
+     * @param {Request} reqConfig - Request configuration for data to get.
+     * @returns {Promise.<Uint8Array?>} Resolve to Buffer of data from server.
+     */
+    get({ url, ...options }: ScratchGetRequest): Promise<Uint8Array | null>;
+    /**
+     * Is sending supported?
+     * Always true for `FetchTool` because `scratchFetch` ponyfills `fetch` if necessary.
+     * @returns {boolean} Is sending supported?
+     */
+    get isSendSupported(): boolean;
+    /**
+     * Send data to a server with fetch.
+     * @param {ScratchSendRequest} reqConfig - Request configuration for data to send.
+     * @returns {Promise.<string>} Server returned metadata.
+     */
+    send({ url, withCredentials, ...options }: ScratchSendRequest): Promise<string>;
+}

package/dist/types/FetchWorkerTool.d.ts

@@ -0,0 +1,29 @@
+import { ScratchGetRequest } from './Tool';
+/**
+ * Get and send assets with a worker that uses fetch.
+ */
+export default class PublicFetchWorkerTool {
+    private inner;
+    constructor();
+    /**
+     * Is get supported?
+     * @returns {boolean} Is get supported?
+     */
+    get isGetSupported(): boolean;
+    /**
+     * Request data from a server with a worker that uses fetch.
+     * @param {{url:string}} reqConfig - Request configuration for data to get.
+     * @returns {Promise.<Buffer|Uint8Array|null>} Resolve to Buffer of data from server.
+     */
+    get(reqConfig: ScratchGetRequest): Promise<Uint8Array | null>;
+    /**
+     * Is sending supported?
+     * @returns {boolean} Is sending supported?
+     */
+    get isSendSupported(): boolean;
+    /**
+     * Send data to a server with a worker that uses fetch.
+     * @throws {Error} A not implemented error.
+     */
+    send(): never;
+}

package/dist/types/Helper.d.ts

@@ -0,0 +1,20 @@
+import Asset, { AssetId } from './Asset';
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+import { ScratchStorage } from './ScratchStorage';
+/**
+ * Base class for asset load/save helpers.
+ * @abstract
+ */
+export default class Helper {
+    parent: ScratchStorage;
+    constructor(parent: ScratchStorage);
+    /**
+     * Fetch an asset but don't process dependencies.
+     * @param {AssetType} assetType - The type of asset to fetch.
+     * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @param {DataFormat} dataFormat - The file format / file extension of the asset to fetch: PNG, JPG, etc.
+     * @return {Promise.<Asset>} A promise for the contents of the asset.
+     */
+    load(assetType: AssetType, assetId: AssetId, dataFormat: DataFormat): Promise<Asset | null> | null;
+}

package/dist/types/ProxyTool.d.ts

@@ -0,0 +1,53 @@
+import { ScratchGetRequest, ScratchSendRequest, Tool } from './Tool';
+/**
+ * @typedef {object} Request
+ * @property {string} url
+ * @property {*} body
+ * @property {string} method
+ * @property {boolean} withCredentials
+ */
+type ToolFilter = typeof ProxyTool.TOOL_FILTER[keyof typeof ProxyTool.TOOL_FILTER];
+/**
+ * Get and send assets with other tools in sequence.
+ */
+export default class ProxyTool implements Tool {
+    tools: Tool[];
+    /**
+     * Constant values that filter the set of tools in a ProxyTool instance.
+     * @enum {string}
+     */
+    static TOOL_FILTER: {
+        /**
+         * Use all tools.
+         */
+        readonly ALL: "all";
+        /**
+         * Use tools that are ready right now.
+         */
+        readonly READY: "ready";
+    };
+    constructor(filter?: ToolFilter);
+    /**
+     * Is get supported? false if all proxied tool return false.
+     * @returns {boolean} Is get supported?
+     */
+    get isGetSupported(): boolean;
+    /**
+     * Request data from with one of the proxied tools.
+     * @param {Request} reqConfig - Request configuration for data to get.
+     * @returns {Promise.<Buffer>} Resolve to Buffer of data from server.
+     */
+    get(reqConfig: ScratchGetRequest): Promise<Uint8Array | null>;
+    /**
+     * Is sending supported? false if all proxied tool return false.
+     * @returns {boolean} Is sending supported?
+     */
+    get isSendSupported(): boolean;
+    /**
+     * Send data to a server with one of the proxied tools.
+     * @param {Request} reqConfig - Request configuration for data to send.
+     * @returns {Promise.<Buffer|string|object>} Server returned metadata.
+     */
+    send(reqConfig: ScratchSendRequest): Promise<string>;
+}
+export {};

package/dist/types/ScratchStorage.d.ts

@@ -0,0 +1,202 @@
+import BuiltinHelper from './BuiltinHelper';
+import WebHelper, { UrlFunction } from './WebHelper';
+import _Asset, { AssetData, AssetId } from './Asset';
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+import Helper from './Helper';
+export declare class ScratchStorage {
+    defaultAssetId: Record<AssetType['name'], AssetId>;
+    builtinHelper: BuiltinHelper;
+    webHelper: WebHelper;
+    private _helpers;
+    constructor();
+    /**
+     * @return {Asset} - the `Asset` class constructor.
+     * @constructor
+     */
+    get Asset(): typeof _Asset;
+    /**
+     * @return {AssetType} - the list of supported asset types.
+     * @constructor
+     */
+    get AssetType(): {
+        readonly ImageBitmap: {
+            readonly contentType: "image/png";
+            readonly name: "ImageBitmap";
+            readonly runtimeFormat: "png";
+            readonly immutable: true;
+        };
+        readonly ImageVector: {
+            readonly contentType: "image/svg+xml";
+            readonly name: "ImageVector";
+            readonly runtimeFormat: "svg";
+            readonly immutable: true;
+        };
+        readonly Project: {
+            readonly contentType: "application/json";
+            readonly name: "Project";
+            readonly runtimeFormat: "json";
+            readonly immutable: false;
+        };
+        readonly Sound: {
+            readonly contentType: "audio/x-wav";
+            readonly name: "Sound";
+            readonly runtimeFormat: "wav";
+            readonly immutable: true;
+        };
+        readonly Sprite: {
+            readonly contentType: "application/json";
+            readonly name: "Sprite";
+            readonly runtimeFormat: "json";
+            readonly immutable: true;
+        };
+    };
+    /**
+     * @return {DataFormat} - the list of supported data formats.
+     * @constructor
+     */
+    get DataFormat(): {
+        readonly JPG: "jpg";
+        readonly JSON: "json";
+        readonly MP3: "mp3";
+        readonly PNG: "png";
+        readonly SB2: "sb2";
+        readonly SB3: "sb3";
+        readonly SVG: "svg";
+        readonly WAV: "wav";
+    };
+    /**
+     * Access the `scratchFetch` module within this library.
+     * @return {module} the scratchFetch module, with properties for `scratchFetch`, `setMetadata`, etc.
+     */
+    get scratchFetch(): any;
+    /**
+     * @deprecated Please use the `Asset` member of a storage instance instead.
+     * @return {Asset} - the `Asset` class constructor.
+     * @constructor
+     */
+    static get Asset(): typeof _Asset;
+    /**
+     * @deprecated Please use the `AssetType` member of a storage instance instead.
+     * @return {AssetType} - the list of supported asset types.
+     * @constructor
+     */
+    static get AssetType(): {
+        readonly ImageBitmap: {
+            readonly contentType: "image/png";
+            readonly name: "ImageBitmap";
+            readonly runtimeFormat: "png";
+            readonly immutable: true;
+        };
+        readonly ImageVector: {
+            readonly contentType: "image/svg+xml";
+            readonly name: "ImageVector";
+            readonly runtimeFormat: "svg";
+            readonly immutable: true;
+        };
+        readonly Project: {
+            readonly contentType: "application/json";
+            readonly name: "Project";
+            readonly runtimeFormat: "json";
+            readonly immutable: false;
+        };
+        readonly Sound: {
+            readonly contentType: "audio/x-wav";
+            readonly name: "Sound";
+            readonly runtimeFormat: "wav";
+            readonly immutable: true;
+        };
+        readonly Sprite: {
+            readonly contentType: "application/json";
+            readonly name: "Sprite";
+            readonly runtimeFormat: "json";
+            readonly immutable: true;
+        };
+    };
+    /**
+     * Add a storage helper to this manager. Helpers with a higher priority number will be checked first when loading
+     * or storing assets. For comparison, the helper for built-in assets has `priority=100` and the default web helper
+     * has `priority=-100`. The relative order of helpers with equal priorities is undefined.
+     * @param {Helper} helper - the helper to be added.
+     * @param {number} [priority] - the priority for this new helper (default: 0).
+     */
+    addHelper(helper: Helper, priority?: number): void;
+    /**
+     * Synchronously fetch a cached asset from built-in storage. Assets are cached when they are loaded.
+     * @param {string} assetId - The id of the asset to fetch.
+     * @returns {?Asset} The asset, if it exists.
+     */
+    get(assetId: string): _Asset | null;
+    /**
+     * Deprecated API for caching built-in assets. Use createAsset.
+     * @param {AssetType} assetType - The type of the asset to cache.
+     * @param {DataFormat} dataFormat - The dataFormat of the data for the cached asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {string} id - The id for the cached asset.
+     * @returns {string} The calculated id of the cached asset, or the supplied id if the asset is mutable.
+     */
+    cache(assetType: AssetType, dataFormat: DataFormat, data: AssetData, id: AssetId): AssetId;
+    /**
+     * Construct an Asset, and optionally generate an md5 hash of its data to create an id
+     * @param {AssetType} assetType - The type of the asset to cache.
+     * @param {DataFormat} dataFormat - The dataFormat of the data for the cached asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {string} [id] - The id for the cached asset.
+     * @param {bool} [generateId] - flag to set id to an md5 hash of data if `id` isn't supplied
+     * @returns {Asset} generated Asset with `id` attribute set if not supplied
+     */
+    createAsset(assetType: AssetType, dataFormat: DataFormat, data: AssetData, id: AssetId, generateId: boolean): _Asset;
+    /**
+     * Register a web-based source for assets. Sources will be checked in order of registration.
+     * @param {Array.<AssetType>} types - The types of asset provided by this source.
+     * @param {UrlFunction} getFunction - A function which computes a GET URL from an Asset.
+     * @param {UrlFunction} createFunction - A function which computes a POST URL for asset data.
+     * @param {UrlFunction} updateFunction - A function which computes a PUT URL for asset data.
+     */
+    addWebStore(types: AssetType[], getFunction: UrlFunction, createFunction?: UrlFunction, updateFunction?: UrlFunction): void;
+    /**
+     * Register a web-based source for assets. Sources will be checked in order of registration.
+     * @deprecated Please use addWebStore
+     * @param {Array.<AssetType>} types - The types of asset provided by this source.
+     * @param {UrlFunction} urlFunction - A function which computes a GET URL from an Asset.
+     */
+    addWebSource(types: AssetType[], urlFunction: UrlFunction): void;
+    /**
+     * TODO: Should this be removed in favor of requesting an asset with `null` as the ID?
+     * @param {AssetType} type - Get the default ID for assets of this type.
+     * @return {?string} The ID of the default asset of the given type, if any.
+     */
+    getDefaultAssetId(type: AssetType): AssetId | undefined;
+    /**
+     * Set the default ID for a particular type of asset. This default asset will be used if a requested asset cannot
+     * be found and automatic fallback is enabled. Ideally this should be an asset that is available locally or even
+     * one built into this module.
+     * TODO: Should this be removed in favor of requesting an asset with `null` as the ID?
+     * @param {AssetType} type - The type of asset for which the default will be set.
+     * @param {string} id - The default ID to use for this type of asset.
+     */
+    setDefaultAssetId(type: AssetType, id: AssetId): void;
+    /**
+     * Fetch an asset by type & ID.
+     * @param {AssetType} assetType - The type of asset to fetch. This also determines which asset store to use.
+     * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @param {DataFormat} [dataFormat] - Optional: load this format instead of the AssetType's default.
+     * @return {Promise.<Asset>} A promise for the requested Asset.
+     *   If the promise is resolved with non-null, the value is the requested asset.
+     *   If the promise is resolved with null, the desired asset could not be found with the current asset sources.
+     *   If the promise is rejected, there was an error on at least one asset source. HTTP 404 does not count as an
+     *   error here, but (for example) HTTP 403 does.
+     */
+    load(assetType: AssetType, assetId: AssetId, dataFormat: DataFormat): Promise<_Asset | null>;
+    /**
+     * Store an asset by type & ID.
+     * @param {AssetType} assetType - The type of asset to fetch. This also determines which asset store to use.
+     * @param {?DataFormat} [dataFormat] - Optional: load this format instead of the AssetType's default.
+     * @param {Buffer} data - Data to store for the asset
+     * @param {?string} [assetId] - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @return {Promise.<object>} A promise for asset metadata
+     */
+    store(assetType: AssetType, dataFormat: DataFormat | null | undefined, data: AssetData, assetId?: AssetId): Promise<string | {
+        id: string;
+    }>;
+}

package/dist/types/Tool.d.ts

@@ -0,0 +1,13 @@
+export type ScratchGetRequest = {
+    url: string;
+} & RequestInit;
+export type ScratchSendRequest = {
+    url: string;
+    withCredentials?: boolean;
+} & RequestInit;
+export interface Tool {
+    get isGetSupported(): boolean;
+    get(request: ScratchGetRequest): Promise<Uint8Array | null>;
+    get isSendSupported(): boolean;
+    send(request: ScratchSendRequest): Promise<string>;
+}

package/dist/types/WebHelper.d.ts

@@ -0,0 +1,59 @@
+import Asset, { AssetData, AssetId } from './Asset';
+import Helper from './Helper';
+import { ScratchGetRequest, ScratchSendRequest, Tool } from './Tool';
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+/**
+ * @typedef {function} UrlFunction - A function which computes a URL from asset information.
+ * @param {Asset} - The asset for which the URL should be computed.
+ * @returns {(string|object)} - A string representing the URL for the asset request OR an object with configuration for
+ *                              the underlying fetch call (necessary for configuring e.g. authentication)
+ */
+export type UrlFunction = (asset: Asset) => string | ScratchGetRequest | ScratchSendRequest;
+interface StoreRecord {
+    types: string[];
+    get: UrlFunction;
+    create?: UrlFunction;
+    update?: UrlFunction;
+}
+export default class WebHelper extends Helper {
+    stores: StoreRecord[];
+    assetTool: Tool;
+    projectTool: Tool;
+    constructor(parent: any);
+    /**
+     * Register a web-based source for assets. Sources will be checked in order of registration.
+     * @deprecated Please use addStore
+     * @param {Array.<AssetType>} types - The types of asset provided by this source.
+     * @param {UrlFunction} urlFunction - A function which computes a URL from an Asset.
+     */
+    addSource(types: AssetType[], urlFunction: UrlFunction): void;
+    /**
+     * Register a web-based store for assets. Sources will be checked in order of registration.
+     * @param {Array.<AssetType>} types - The types of asset provided by this store.
+     * @param {UrlFunction} getFunction - A function which computes a GET URL for an Asset
+     * @param {UrlFunction} createFunction - A function which computes a POST URL for an Asset
+     * @param {UrlFunction} updateFunction - A function which computes a PUT URL for an Asset
+     */
+    addStore(types: AssetType[], getFunction: UrlFunction, createFunction?: UrlFunction, updateFunction?: UrlFunction): void;
+    /**
+     * Fetch an asset but don't process dependencies.
+     * @param {AssetType} assetType - The type of asset to fetch.
+     * @param {string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @param {DataFormat} dataFormat - The file format / file extension of the asset to fetch: PNG, JPG, etc.
+     * @return {Promise.<Asset>} A promise for the contents of the asset.
+     */
+    load(assetType: AssetType, assetId: AssetId, dataFormat: DataFormat): Promise<Asset | null>;
+    /**
+     * Create or update an asset with provided data. The create function is called if no asset id is provided
+     * @param {AssetType} assetType - The type of asset to create or update.
+     * @param {?DataFormat} dataFormat - DataFormat of the data for the stored asset.
+     * @param {Buffer} data - The data for the cached asset.
+     * @param {?string} assetId - The ID of the asset to fetch: a project ID, MD5, etc.
+     * @return {Promise.<object>} A promise for the response from the create or update request
+     */
+    store(assetType: AssetType, dataFormat: DataFormat | undefined, data: AssetData, assetId?: AssetId): Promise<string | {
+        id: string;
+    }>;
+}
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,11 @@
+import { ScratchStorage } from './ScratchStorage';
+import Asset, { AssetId } from './Asset';
+import { AssetType } from './AssetType';
+import { DataFormat } from './DataFormat';
+import Helper from './Helper';
+export { 
+/**
+ * Export for use with NPM & Node.js.
+ * @type {ScratchStorage}
+ */
+ScratchStorage, Asset, AssetId, AssetType, DataFormat, Helper };

package/dist/types/log.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/types/memoizedToString.d.ts

@@ -0,0 +1,5 @@
+import { AssetId } from './Asset';
+declare let _TextDecoder: typeof TextDecoder;
+declare let _TextEncoder: typeof TextEncoder;
+declare const memoizedToString: (assetId: AssetId, data: Uint8Array) => any;
+export { memoizedToString, _TextEncoder, _TextDecoder };

package/dist/web/chunks/fetch-worker.85da71862ab8ee15f1cd.js

@@ -0,0 +1,2 @@
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ScratchStorage=e():t.ScratchStorage=e()}(self,(()=>(()=>{var t={945:function(t,e){var r="undefined"!=typeof self?self:this,o=function(){function t(){this.fetch=!1,this.DOMException=r.DOMException}return t.prototype=r,new t}();!function(t){!function(e){var r="URLSearchParams"in t,o="Symbol"in t&&"iterator"in Symbol,n="FileReader"in t&&"Blob"in t&&function(){try{return new Blob,!0}catch(t){return!1}}(),i="FormData"in t,s="ArrayBuffer"in t;if(s)var a=["[object Int8Array]","[object Uint8Array]","[object Uint8ClampedArray]","[object Int16Array]","[object Uint16Array]","[object Int32Array]","[object Uint32Array]","[object Float32Array]","[object Float64Array]"],h=ArrayBuffer.isView||function(t){return t&&a.indexOf(Object.prototype.toString.call(t))>-1};function u(t){if("string"!=typeof t&&(t=String(t)),/[^a-z0-9\-#$%&'*+.^_`|~]/i.test(t))throw new TypeError("Invalid character in header field name");return t.toLowerCase()}function f(t){return"string"!=typeof t&&(t=String(t)),t}function c(t){var e={next:function(){var e=t.shift();return{done:void 0===e,value:e}}};return o&&(e[Symbol.iterator]=function(){return e}),e}function d(t){this.map={},t instanceof d?t.forEach((function(t,e){this.append(e,t)}),this):Array.isArray(t)?t.forEach((function(t){this.append(t[0],t[1])}),this):t&&Object.getOwnPropertyNames(t).forEach((function(e){this.append(e,t[e])}),this)}function p(t){if(t.bodyUsed)return Promise.reject(new TypeError("Already read"));t.bodyUsed=!0}function l(t){return new Promise((function(e,r){t.onload=function(){e(t.result)},t.onerror=function(){r(t.error)}}))}function y(t){var e=new FileReader,r=l(e);return e.readAsArrayBuffer(t),r}function b(t){if(t.slice)return t.slice(0);var e=new Uint8Array(t.byteLength);return e.set(new Uint8Array(t)),e.buffer}function m(){return this.bodyUsed=!1,this._initBody=function(t){var e;this._bodyInit=t,t?"string"==typeof t?this._bodyText=t:n&&Blob.prototype.isPrototypeOf(t)?this._bodyBlob=t:i&&FormData.prototype.isPrototypeOf(t)?this._bodyFormData=t:r&&URLSearchParams.prototype.isPrototypeOf(t)?this._bodyText=t.toString():s&&n&&((e=t)&&DataView.prototype.isPrototypeOf(e))?(this._bodyArrayBuffer=b(t.buffer),this._bodyInit=new Blob([this._bodyArrayBuffer])):s&&(ArrayBuffer.prototype.isPrototypeOf(t)||h(t))?this._bodyArrayBuffer=b(t):this._bodyText=t=Object.prototype.toString.call(t):this._bodyText="",this.headers.get("content-type")||("string"==typeof t?this.headers.set("content-type","text/plain;charset=UTF-8"):this._bodyBlob&&this._bodyBlob.type?this.headers.set("content-type",this._bodyBlob.type):r&&URLSearchParams.prototype.isPrototypeOf(t)&&this.headers.set("content-type","application/x-www-form-urlencoded;charset=UTF-8"))},n&&(this.blob=function(){var t=p(this);if(t)return t;if(this._bodyBlob)return Promise.resolve(this._bodyBlob);if(this._bodyArrayBuffer)return Promise.resolve(new Blob([this._bodyArrayBuffer]));if(this._bodyFormData)throw new Error("could not read FormData body as blob");return Promise.resolve(new Blob([this._bodyText]))},this.arrayBuffer=function(){return this._bodyArrayBuffer?p(this)||Promise.resolve(this._bodyArrayBuffer):this.blob().then(y)}),this.text=function(){var t,e,r,o=p(this);if(o)return o;if(this._bodyBlob)return t=this._bodyBlob,e=new FileReader,r=l(e),e.readAsText(t),r;if(this._bodyArrayBuffer)return Promise.resolve(function(t){for(var e=new Uint8Array(t),r=new Array(e.length),o=0;o<e.length;o++)r[o]=String.fromCharCode(e[o]);return r.join("")}(this._bodyArrayBuffer));if(this._bodyFormData)throw new Error("could not read FormData body as text");return Promise.resolve(this._bodyText)},i&&(this.formData=function(){return this.text().then(x)}),this.json=function(){return this.text().then(JSON.parse)},this}d.prototype.append=function(t,e){t=u(t),e=f(e);var r=this.map[t];this.map[t]=r?r+", "+e:e},d.prototype.delete=function(t){delete this.map[u(t)]},d.prototype.get=function(t){return t=u(t),this.has(t)?this.map[t]:null},d.prototype.has=function(t){return this.map.hasOwnProperty(u(t))},d.prototype.set=function(t,e){this.map[u(t)]=f(e)},d.prototype.forEach=function(t,e){for(var r in this.map)this.map.hasOwnProperty(r)&&t.call(e,this.map[r],r,this)},d.prototype.keys=function(){var t=[];return this.forEach((function(e,r){t.push(r)})),c(t)},d.prototype.values=function(){var t=[];return this.forEach((function(e){t.push(e)})),c(t)},d.prototype.entries=function(){var t=[];return this.forEach((function(e,r){t.push([r,e])})),c(t)},o&&(d.prototype[Symbol.iterator]=d.prototype.entries);var w=["DELETE","GET","HEAD","OPTIONS","POST","PUT"];function v(t,e){var r,o,n=(e=e||{}).body;if(t instanceof v){if(t.bodyUsed)throw new TypeError("Already read");this.url=t.url,this.credentials=t.credentials,e.headers||(this.headers=new d(t.headers)),this.method=t.method,this.mode=t.mode,this.signal=t.signal,n||null==t._bodyInit||(n=t._bodyInit,t.bodyUsed=!0)}else this.url=String(t);if(this.credentials=e.credentials||this.credentials||"same-origin",!e.headers&&this.headers||(this.headers=new d(e.headers)),this.method=(r=e.method||this.method||"GET",o=r.toUpperCase(),w.indexOf(o)>-1?o:r),this.mode=e.mode||this.mode||null,this.signal=e.signal||this.signal,this.referrer=null,("GET"===this.method||"HEAD"===this.method)&&n)throw new TypeError("Body not allowed for GET or HEAD requests");this._initBody(n)}function x(t){var e=new FormData;return t.trim().split("&").forEach((function(t){if(t){var r=t.split("="),o=r.shift().replace(/\+/g," "),n=r.join("=").replace(/\+/g," ");e.append(decodeURIComponent(o),decodeURIComponent(n))}})),e}function E(t,e){e||(e={}),this.type="default",this.status=void 0===e.status?200:e.status,this.ok=this.status>=200&&this.status<300,this.statusText="statusText"in e?e.statusText:"OK",this.headers=new d(e.headers),this.url=e.url||"",this._initBody(t)}v.prototype.clone=function(){return new v(this,{body:this._bodyInit})},m.call(v.prototype),m.call(E.prototype),E.prototype.clone=function(){return new E(this._bodyInit,{status:this.status,statusText:this.statusText,headers:new d(this.headers),url:this.url})},E.error=function(){var t=new E(null,{status:0,statusText:""});return t.type="error",t};var g=[301,302,303,307,308];E.redirect=function(t,e){if(-1===g.indexOf(e))throw new RangeError("Invalid status code");return new E(null,{status:e,headers:{location:t}})},e.DOMException=t.DOMException;try{new e.DOMException}catch(t){e.DOMException=function(t,e){this.message=t,this.name=e;var r=Error(t);this.stack=r.stack},e.DOMException.prototype=Object.create(Error.prototype),e.DOMException.prototype.constructor=e.DOMException}function A(t,r){return new Promise((function(o,i){var s=new v(t,r);if(s.signal&&s.signal.aborted)return i(new e.DOMException("Aborted","AbortError"));var a=new XMLHttpRequest;function h(){a.abort()}a.onload=function(){var t,e,r={status:a.status,statusText:a.statusText,headers:(t=a.getAllResponseHeaders()||"",e=new d,t.replace(/\r?\n[\t ]+/g," ").split(/\r?\n/).forEach((function(t){var r=t.split(":"),o=r.shift().trim();if(o){var n=r.join(":").trim();e.append(o,n)}})),e)};r.url="responseURL"in a?a.responseURL:r.headers.get("X-Request-URL");var n="response"in a?a.response:a.responseText;o(new E(n,r))},a.onerror=function(){i(new TypeError("Network request failed"))},a.ontimeout=function(){i(new TypeError("Network request failed"))},a.onabort=function(){i(new e.DOMException("Aborted","AbortError"))},a.open(s.method,s.url,!0),"include"===s.credentials?a.withCredentials=!0:"omit"===s.credentials&&(a.withCredentials=!1),"responseType"in a&&n&&(a.responseType="blob"),s.headers.forEach((function(t,e){a.setRequestHeader(e,t)})),s.signal&&(s.signal.addEventListener("abort",h),a.onreadystatechange=function(){4===a.readyState&&s.signal.removeEventListener("abort",h)}),a.send(void 0===s._bodyInit?null:s._bodyInit)}))}A.polyfill=!0,t.fetch||(t.fetch=A,t.Headers=d,t.Request=v,t.Response=E),e.Headers=d,e.Request=v,e.Response=E,e.fetch=A,Object.defineProperty(e,"__esModule",{value:!0})}({})}(o),o.fetch.ponyfill=!0,delete o.fetch.polyfill;var n=o;(e=n.fetch).default=n.fetch,e.fetch=n.fetch,e.Headers=n.Headers,e.Request=n.Request,e.Response=n.Response,t.exports=e}},e={};const r=function r(o){var n=e[o];if(void 0!==n)return n.exports;var i=e[o]={exports:{}};return t[o].call(i.exports,i,i.exports,r),i.exports}(945).default;let o=0;const n=[];let i=null;return postMessage({support:{fetch:!0}}),self.addEventListener("message",(t=>{let{data:e}=t;0!==o||i||(i=setInterval((()=>{n.length&&(postMessage(n.slice(),n.map((t=>t.buffer)).filter(Boolean)),n.length=0),0===o&&(clearInterval(i),i=null)}),1)),o++,r(e.url,e.options).then((t=>t.ok?t.arrayBuffer():404===t.status?null:Promise.reject(t.status))).then((t=>n.push({id:e.id,buffer:t}))).catch((t=>n.push({id:e.id,error:t&&t.message||"Failed request: ".concat(e.url)}))).then((()=>o--))})),{}})()));
+//# sourceMappingURL=fetch-worker.85da71862ab8ee15f1cd.js.map

package/dist/web/chunks/fetch-worker.85da71862ab8ee15f1cd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunks/fetch-worker.85da71862ab8ee15f1cd.js","mappings":"AAAA","sources":["webpack://ScratchStorage/webpack/universalModuleDefinition"],"sourcesContent":["(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ScratchStorage\"] = factory();\n\telse\n\t\troot[\"ScratchStorage\"] = factory();\n})(self, () => {\nreturn "],"names":[],"sourceRoot":""}