@particle-academy/gmail-inbox-js 0.0.0 → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,223 @@
+import { ServiceDescriptor, PreparedRequest, ConnectorMode, ConnectorFaker, RequestedMode, Transport, ConnectorResult } from '@particle-academy/fancy-connector-core';
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/manifest.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/manifest.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * Gmail Inbox, as one service descriptor shared by every Gmail Inbox
+ * operation.
+ *
+ * @particle-academy/fancy-connector-core carries what is true of ALL
+ * connectors. This carries what is true of Gmail Inbox: its base URL, its auth
+ * scheme, its idempotency header, and its faker.
+ *
+ * ## The sandbox trap, written down where it is used
+ *
+ * Gmail has no sandbox. Every read reaches the connected account's real mail.
+ * The faker is the only way to develop against it without touching a real
+ * mailbox.
+ */
+
+/**
+ * The connector API version this package was GENERATED against.
+ *
+ * A literal, never imported. An imported constant lets an upgrade rewrite the
+ * very claim it exists to detect, after which the copy agrees with itself
+ * forever.
+ */
+declare const CONNECTOR_API_VERSION = 1;
+declare const GMAIL_INBOX_BASE_URLS: {
+    readonly live: "https://gmail.googleapis.com";
+};
+/** Credential keys a remote call cannot proceed without. */
+declare const GMAIL_INBOX_REQUIRES: readonly ["accessToken", "refreshToken", "clientId", "clientSecret"];
+/**
+ * Apply Gmail Inbox's auth scheme to an outgoing request.
+ *
+ *
+ *
+ * The mode is passed in because for some providers auth and estate are the
+ * same decision expressed in the URL; here it is unused, and saying so is
+ * cheaper than wondering later whether it was forgotten.
+ */
+declare function gmailInboxAuthorize(credentials: Record<string, string | undefined>, request: PreparedRequest, _mode: ConnectorMode): void;
+/** The Gmail Inbox service, for the TypeScript runtime. */
+declare const GMAIL_INBOX: ServiceDescriptor;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/fixtures/ by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/fixtures/ (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * The Gmail Inbox faker.
+ *
+ * Shapes, not behaviour: the goal is that a downstream node sees the field
+ * NAMES Gmail Inbox actually publishes, so an author can wire {{ $json.data.id
+ * }} against a fake and have it keep working against the real thing.
+ *
+ * Deterministic — same inputs, same output. A faker returning a fresh uuid
+ * every call cannot be asserted on, so its fixtures degrade to "it did not
+ * throw", which is the assertion that catches nothing.
+ */
+
+declare const gmailInboxFaker: ConnectorFaker;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/actions/label-list.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/actions/label-list.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * List every label on the mailbox, system and user-created.
+ *
+ * GET /gmail/v1/users/{userId}/labels —
+ * https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.labels/list
+ *
+ * Notice what is NOT here: no key, no base URL, no mode check, no retry loop,
+ * no fake/real branch. This describes the request; callConnector resolves the
+ * connection, picks the estate, and either calls Gmail Inbox or calls the
+ * faker.
+ */
+
+declare const LABEL_LIST_OPERATION = "label_list";
+type LabelListOptions = {
+    /** The node's resolved config. Keys: userId. */
+    config: Record<string, unknown>;
+    credentials?: Record<string, string | undefined>;
+    mode?: RequestedMode;
+    connectionId?: string | null;
+    input?: unknown;
+    attempts?: number;
+    /** Override the transport. The only way to exercise this without a network. */
+    transport?: Transport;
+};
+declare function gmailInboxLabelList(options: LabelListOptions): Promise<ConnectorResult>;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/actions/message-get.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/actions/message-get.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * Read one message's headers and preview. The body's plain/HTML text is NOT
+ * decoded -- see the raw payload for that.
+ *
+ * GET /gmail/v1/users/{userId}/messages/{id} —
+ * https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.messages/get
+ *
+ * Notice what is NOT here: no key, no base URL, no mode check, no retry loop,
+ * no fake/real branch. This describes the request; callConnector resolves the
+ * connection, picks the estate, and either calls Gmail Inbox or calls the
+ * faker.
+ */
+
+declare const MESSAGE_GET_OPERATION = "message_get";
+type MessageGetOptions = {
+    /** The node's resolved config. Keys: userId, id. */
+    config: Record<string, unknown>;
+    credentials?: Record<string, string | undefined>;
+    mode?: RequestedMode;
+    connectionId?: string | null;
+    input?: unknown;
+    attempts?: number;
+    /** Override the transport. The only way to exercise this without a network. */
+    transport?: Transport;
+};
+declare function gmailInboxMessageGet(options: MessageGetOptions): Promise<ConnectorResult>;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/actions/message-list.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/actions/message-list.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * List message ids matching a search, newest first.
+ *
+ * GET /gmail/v1/users/{userId}/messages —
+ * https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.messages/list
+ *
+ * Notice what is NOT here: no key, no base URL, no mode check, no retry loop,
+ * no fake/real branch. This describes the request; callConnector resolves the
+ * connection, picks the estate, and either calls Gmail Inbox or calls the
+ * faker.
+ */
+
+declare const MESSAGE_LIST_OPERATION = "message_list";
+type MessageListOptions = {
+    /** The node's resolved config. Keys: userId, q, labelId, includeSpamTrash, maxResults, pageToken. */
+    config: Record<string, unknown>;
+    credentials?: Record<string, string | undefined>;
+    mode?: RequestedMode;
+    connectionId?: string | null;
+    input?: unknown;
+    attempts?: number;
+    /** Override the transport. The only way to exercise this without a network. */
+    transport?: Transport;
+};
+declare function gmailInboxMessageList(options: MessageListOptions): Promise<ConnectorResult>;
+
+/**
+ * GENERATED FILE — do not edit.
+ *
+ * Emitted from provider/actions/thread-get.json by weaver's generator.
+ * A hand-edit here is destroyed by the next protocol sync, which is worse than
+ * being rejected, because it works until it silently does not. Fix
+ * provider/actions/thread-get.json (or weaver's template/) and regenerate:
+ *
+ *     npm run provider -- gmail_inbox
+ */
+/**
+ * Read every message in a conversation thread, oldest first.
+ *
+ * GET /gmail/v1/users/{userId}/threads/{id} —
+ * https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.threads/get
+ *
+ * Notice what is NOT here: no key, no base URL, no mode check, no retry loop,
+ * no fake/real branch. This describes the request; callConnector resolves the
+ * connection, picks the estate, and either calls Gmail Inbox or calls the
+ * faker.
+ */
+
+declare const THREAD_GET_OPERATION = "thread_get";
+type ThreadGetOptions = {
+    /** The node's resolved config. Keys: userId, id. */
+    config: Record<string, unknown>;
+    credentials?: Record<string, string | undefined>;
+    mode?: RequestedMode;
+    connectionId?: string | null;
+    input?: unknown;
+    attempts?: number;
+    /** Override the transport. The only way to exercise this without a network. */
+    transport?: Transport;
+};
+declare function gmailInboxThreadGet(options: ThreadGetOptions): Promise<ConnectorResult>;
+
+export { CONNECTOR_API_VERSION, GMAIL_INBOX, GMAIL_INBOX_BASE_URLS, GMAIL_INBOX_REQUIRES, LABEL_LIST_OPERATION, type LabelListOptions, MESSAGE_GET_OPERATION, MESSAGE_LIST_OPERATION, type MessageGetOptions, type MessageListOptions, THREAD_GET_OPERATION, type ThreadGetOptions, gmailInboxAuthorize, gmailInboxFaker, gmailInboxLabelList, gmailInboxMessageGet, gmailInboxMessageList, gmailInboxThreadGet };

package/dist/index.js

@@ -0,0 +1,3 @@
+export { CONNECTOR_API_VERSION, GMAIL_INBOX, GMAIL_INBOX_BASE_URLS, GMAIL_INBOX_REQUIRES, LABEL_LIST_OPERATION, MESSAGE_GET_OPERATION, MESSAGE_LIST_OPERATION, THREAD_GET_OPERATION, gmailInboxAuthorize, gmailInboxFaker, gmailInboxLabelList, gmailInboxMessageGet, gmailInboxMessageList, gmailInboxThreadGet } from './chunk-UT3U2BPM.js';
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}

package/package.json

@@ -1,18 +1,90 @@
 {
   "name": "@particle-academy/gmail-inbox-js",
-  "version": "0.0.0",
-  "description": "A placeholder that claims the name @particle-academy/gmail-inbox-js; the real release follows through Fancy-Friends/gmail-inbox's publish.yml with provenance. Do not install this version.",
-  "license": "MIT",
+  "version": "0.1.0",
+  "description": "Gmail Inbox for Node — the service descriptor, its faker, its webhook verification, and one function per operation. Plain HTTP on @particle-academy/fancy-connector-core; no vendor SDK.",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Fancy-Friends/gmail-inbox.git",
     "directory": "packages/js"
   },
   "homepage": "https://github.com/Fancy-Friends/gmail-inbox#readme",
+  "bugs": "https://github.com/Fancy-Friends/gmail-inbox/issues",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./flow": {
+      "import": {
+        "types": "./dist/flow.d.ts",
+        "default": "./dist/flow.js"
+      },
+      "require": {
+        "types": "./dist/flow.d.cts",
+        "default": "./dist/flow.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "art",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "lint": "tsc --noEmit",
+    "test": "node --import tsx --test tests/*.test.ts",
+    "prepublishOnly": "tsup"
+  },
+  "dependencies": {
+    "@particle-academy/fancy-connector-core": ">=0.4.0 <2.0"
+  },
+  "peerDependencies": {
+    "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
+    "@particle-academy/gmail-inbox-ui": ">=0.1.0 <0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@particle-academy/fancy-flow": {
+      "optional": true
+    },
+    "@particle-academy/gmail-inbox-ui": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@particle-academy/fancy-flow": ">=0.47.1 <2.0",
+    "@types/node": "^26.2.0",
+    "tsup": "^8.5.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.8.0"
+  },
   "publishConfig": {
     "access": "public"
   },
-  "files": [
-    "README.md"
-  ]
+  "keywords": [
+    "gmail_inbox",
+    "email",
+    "connector",
+    "api",
+    "fancy-ui",
+    "particle-academy"
+  ],
+  "license": "MIT",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  }
 }