@nohead/sdk 0.6.0 → 0.7.0

package/dist/resources/assets.d.ts

@@ -13,7 +13,6 @@ export interface UploadParams {
     /** Required for a `ReadableStream`; known for everything else. */
     byte_size?: number;
 }
-/** Files of the key's project. `asset` is an asset ID (`ast_…`). */
 export declare class Assets extends Resource {
     /**
      * Uploads a file and returns the `ready` asset: creates the upload, sends
@@ -28,6 +27,9 @@ export declare class Assets extends Resource {
      *
      *   import { openAsBlob } from "node:fs"
      *   const asset = await nohead.assets.upload(await openAsBlob("a.jpg"), { filename: "a.jpg" })
+     *
+     * Without `content_type`, the type is the Blob's, or else the filename's
+     * extension's for common files.
      */
     upload(file: Uploadable, params?: UploadParams, options?: RequestOptions): Promise<Asset>;
     /**
@@ -38,7 +40,7 @@ export declare class Assets extends Resource {
     createUpload(params: AssetUploadCreate, options?: RequestOptions): APIPromise<AssetWithUpload>;
     /** Checks an uploaded file and marks the asset `ready`. */
     complete(asset: string, options?: RequestOptions): APIPromise<Asset>;
-    list({ content_type, ...params }?: AssetListParams, options?: RequestOptions): PagePromise<Asset>;
+    list({ content_type, kind, ...params }?: AssetListParams, options?: RequestOptions): PagePromise<Asset>;
     get(asset: string, options?: RequestOptions): APIPromise<Asset>;
     /**
      * Renames the asset (`filename`) or sets its `alt` text (`null` or `""`

package/dist/resources/assets.js

@@ -1,6 +1,31 @@
 import { AbortError, UploadError } from "../errors.js";
 import { listQuery, Resource } from "./resource.js";
 /** Files of the key's project. `asset` is an asset ID (`ast_…`). */
+/** Common files' types by extension, as the other SDKs guess them. */
+const CONTENT_TYPES = {
+    avif: "image/avif",
+    gif: "image/gif",
+    jpeg: "image/jpeg",
+    jpg: "image/jpeg",
+    png: "image/png",
+    svg: "image/svg+xml",
+    webp: "image/webp",
+    pdf: "application/pdf",
+    json: "application/json",
+    txt: "text/plain",
+    md: "text/markdown",
+    csv: "text/csv",
+    mp3: "audio/mpeg",
+    mp4: "video/mp4",
+    webm: "video/webm",
+    zip: "application/zip",
+};
+function contentTypeOf(filename) {
+    const dot = filename.lastIndexOf(".");
+    return dot > 0
+        ? CONTENT_TYPES[filename.slice(dot + 1).toLowerCase()]
+        : undefined;
+}
 export class Assets extends Resource {
     /**
      * Uploads a file and returns the `ready` asset: creates the upload, sends
@@ -15,19 +40,28 @@ export class Assets extends Resource {
      *
      *   import { openAsBlob } from "node:fs"
      *   const asset = await nohead.assets.upload(await openAsBlob("a.jpg"), { filename: "a.jpg" })
+     *
+     * Without `content_type`, the type is the Blob's, or else the filename's
+     * extension's for common files.
      */
     async upload(file, params = {}, options) {
         const byteSize = params.byte_size ?? sizeOf(file);
         if (byteSize === undefined) {
             throw new UploadError("Uploading a stream needs `byte_size`");
         }
+        const filename = params.filename ??
+            (typeof File !== "undefined" && file instanceof File
+                ? file.name
+                : "upload");
         const { upload, ...asset } = await this.createUpload({
-            filename: params.filename ??
-                (typeof File !== "undefined" && file instanceof File
-                    ? file.name
-                    : "upload"),
+            filename,
+            // The Blob's own type, or one the filename's extension implies (a
+            // Blob from Node's openAsBlob has none), as the Python and Ruby
+            // SDKs do.
             content_type: params.content_type ??
-                ((file instanceof Blob && file.type) || "application/octet-stream"),
+                ((file instanceof Blob && file.type) ||
+                    contentTypeOf(filename) ||
+                    "application/octet-stream"),
             byte_size: byteSize,
         }, options);
         // A replayed start returns the first run's asset, which may be done.
@@ -74,14 +108,15 @@ export class Assets extends Resource {
     complete(asset, options) {
         return this.core.request("assets_complete", { path: { asset_id: asset } }, options);
     }
-    list({ content_type, ...params } = {}, options) {
+    list({ content_type, kind, ...params } = {}, options) {
         return this.core.paginate("assets_list", {
             query: listQuery({
                 ...params,
                 content_type: Array.isArray(content_type)
                     ? { in: content_type }
                     : content_type,
-            }, ["deleted", "content_type"]),
+                kind: Array.isArray(kind) ? { in: kind } : kind,
+            }, ["deleted", "content_type", "kind"]),
         }, options);
     }
     get(asset, options) {

package/dist/resources/records.d.ts

@@ -53,9 +53,9 @@ export declare class Records extends Resource {
     /** Clears both scheduled times. */
     unschedule(record: string, options?: RequestOptions): APIPromise<RecordSchedule>;
     /**
-     * A collection's pending scheduled publishes and unpublishes, soonest
-     * first: one per change, so a record due to publish and later unpublish
-     * appears twice.
+     * A collection's pending scheduled changes, soonest first: publishes,
+     * unpublishes and draft merges, one per change, so a record due to publish
+     * and later unpublish appears twice.
      */
     scheduledChanges(collection: string, params?: ScheduledChangeListParams, options?: RequestOptions): PagePromise<ScheduledChange>;
     count(collection: string, params?: RecordCountParams, options?: RequestOptions): APIPromise<RecordCount>;

package/dist/resources/records.js

@@ -75,9 +75,9 @@ export class Records extends Resource {
         return this.core.request("records_unschedule", { path: { record_id: record } }, options);
     }
     /**
-     * A collection's pending scheduled publishes and unpublishes, soonest
-     * first: one per change, so a record due to publish and later unpublish
-     * appears twice.
+     * A collection's pending scheduled changes, soonest first: publishes,
+     * unpublishes and draft merges, one per change, so a record due to publish
+     * and later unpublish appears twice.
      */
     scheduledChanges(collection, params = {}, options) {
         return this.core.paginate("scheduled_changes_list", { path: { collection_id: collection }, query: params }, options);

package/dist/types.d.ts

@@ -157,6 +157,17 @@ export interface DeletedListParams extends ListParams {
     deleted?: boolean;
 }
 export interface AssetListParams extends DeletedListParams {
+    /**
+     * Words that must each appear in the filename or the alt text, ignoring
+     * case: `"hero jpg"` finds `Hero-banner.jpg`.
+     */
+    q?: string;
+    /**
+     * Only assets of a kind, or of any of several: `"image"`, `"video"` and
+     * `"audio"` by their types, `"document"` for PDFs, text and office files,
+     * `"other"` for every other file.
+     */
+    kind?: G.AssetKind | G.AssetKind[];
     /**
      * Only assets of a MIME type or `type/*` wildcard (`"image/*"`), or of any
      * of several: `["image/*", "application/pdf"]`, such as an asset

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.6.0";
+export declare const VERSION = "0.7.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.6.0";
+export const VERSION = "0.7.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nohead/sdk",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "Official TypeScript SDK for the Nohead API",
   "license": "MIT",
   "homepage": "https://nohead.io",