@doist/twist-sdk 2.2.0 → 2.3.0

package/README.md

@@ -21,7 +21,8 @@ import { TwistApi } from '@doist/twist-sdk'
 
 const api = new TwistApi('YOUR_API_TOKEN')
 
-api.users.getSessionUser()
+api.users
+    .getSessionUser()
     .then((user) => console.log(user))
     .catch((error) => console.log(error))
 ```
@@ -38,7 +39,7 @@ const authUrl = getAuthorizationUrl(
     'your-client-id',
     ['user:read', 'channels:read'],
     'state-parameter',
-    'https://yourapp.com/callback'
+    'https://yourapp.com/callback',
 )
 
 // Step 2: Exchange authorization code for access token
@@ -46,7 +47,7 @@ const tokenResponse = await getAuthToken({
     clientId: 'your-client-id',
     clientSecret: 'your-client-secret',
     code: 'authorization-code',
-    redirectUri: 'https://yourapp.com/callback'
+    redirectUri: 'https://yourapp.com/callback',
 })
 
 // Step 3: Use the access token
@@ -76,7 +77,7 @@ const user2 = await api.workspaceUsers.getUserById(123, 789)
 // Batch requests - executes in a single HTTP call
 const results = await api.batch(
     api.workspaceUsers.getUserById(123, 456, { batch: true }),
-    api.workspaceUsers.getUserById(123, 789, { batch: true })
+    api.workspaceUsers.getUserById(123, 789, { batch: true }),
 )
 
 console.log(results[0].data.name) // First user
@@ -94,7 +95,7 @@ Each item in the batch response includes:
 ```typescript
 const results = await api.batch(
     api.channels.getChannel(123, { batch: true }),
-    api.channels.getChannel(456, { batch: true })
+    api.channels.getChannel(456, { batch: true }),
 )
 
 results.forEach((result) => {
@@ -115,7 +116,7 @@ When all requests in a batch are GET requests, they are executed in parallel on
 const results = await api.batch(
     api.workspaceUsers.getUserById(123, 456, { batch: true }),
     api.channels.getChannel(789, { batch: true }),
-    api.threads.getThread(101112, { batch: true })
+    api.threads.getThread(101112, { batch: true }),
 )
 ```
 
@@ -127,7 +128,7 @@ You can batch requests across different resource types:
 const results = await api.batch(
     api.workspaceUsers.getUserById(123, 456, { batch: true }),
     api.channels.getChannels({ workspaceId: 123 }, { batch: true }),
-    api.conversations.getConversations({ workspaceId: 123 }, { batch: true })
+    api.conversations.getConversations({ workspaceId: 123 }, { batch: true }),
 )
 
 const [user, channels, conversations] = results
@@ -144,7 +145,7 @@ Individual requests in a batch can fail independently. Always check the status c
 ```typescript
 const results = await api.batch(
     api.channels.getChannel(123, { batch: true }),
-    api.channels.getChannel(999999, { batch: true }) // Non-existent channel
+    api.channels.getChannel(999999, { batch: true }), // Non-existent channel
 )
 
 results.forEach((result, index) => {
@@ -178,7 +179,8 @@ import { TwistApi } from './twist-api'
 const token = 'YOUR_API_TOKEN'
 const api = new TwistApi(token)
 
-api.workspaces.getWorkspaces()
+api.workspaces
+    .getWorkspaces()
     .then((workspaces) => {
         console.log(workspaces)
     })

package/dist/cjs/authentication.js

@@ -46,12 +46,24 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TWIST_SCOPES = void 0;
+exports.TOKEN_ENDPOINT_AUTH_METHODS = exports.TWIST_SCOPES = void 0;
 exports.getAuthStateParameter = getAuthStateParameter;
 exports.getAuthorizationUrl = getAuthorizationUrl;
 exports.getAuthToken = getAuthToken;
 exports.revokeAuthToken = revokeAuthToken;
+exports.registerClient = registerClient;
 var uuid_1 = require("uuid");
 var http_client_1 = require("./transport/http-client");
 var errors_1 = require("./types/errors");
@@ -139,9 +151,22 @@ exports.TWIST_SCOPES = [
     'notifications:read',
     'notifications:write',
 ];
+/** Supported token endpoint authentication methods for dynamic client registration. */
+exports.TOKEN_ENDPOINT_AUTH_METHODS = [
+    'client_secret_post',
+    'client_secret_basic',
+    'none',
+];
 function getAuthStateParameter() {
     return (0, uuid_1.v4)();
 }
+/**
+ * Generates the authorization URL for the OAuth2 flow.
+ *
+ * The `clientId` can be either a traditional client ID string (e.g. from
+ * {@link registerClient}) or an HTTPS URL pointing to a client metadata document,
+ * as defined in {@link https://drafts.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/ RFC draft-ietf-oauth-client-id-metadata-document}.
+ */
 function getAuthorizationUrl(clientId, scopes, state, redirectUri, baseUrl) {
     if (!(scopes === null || scopes === void 0 ? void 0 : scopes.length)) {
         throw new Error('At least one scope value is required.');
@@ -214,3 +239,52 @@ function revokeAuthToken(args, options) {
         });
     });
 }
+/**
+ * Registers a new OAuth client via Dynamic Client Registration (RFC 7591).
+ *
+ * @example
+ * ```typescript
+ * const client = await registerClient({
+ *   redirectUris: ['https://example.com/callback'],
+ *   clientName: 'My App',
+ *   scope: ['user:read', 'channels:read'],
+ * })
+ * // Use client.clientId and client.clientSecret for OAuth flows
+ * ```
+ *
+ * @returns The registered client details
+ * @throws {@link TwistRequestError} If the registration fails
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
+ */
+function registerClient(args, options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var registerUrl, response, _a, clientIdIssuedAt, clientSecretExpiresAt, scope, rest;
+        var _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    registerUrl = (options === null || options === void 0 ? void 0 : options.baseUrl)
+                        ? "".concat(options.baseUrl, "/oauth/register")
+                        : 'https://twist.com/oauth/register';
+                    return [4 /*yield*/, (0, http_client_1.request)({
+                            httpMethod: 'POST',
+                            baseUri: registerUrl,
+                            relativePath: '',
+                            payload: __assign(__assign({}, args), { scope: (_b = args.scope) === null || _b === void 0 ? void 0 : _b.join(' ') }),
+                            customFetch: options === null || options === void 0 ? void 0 : options.customFetch,
+                        })];
+                case 1:
+                    response = _d.sent();
+                    if (!(0, http_client_1.isSuccess)(response) || !((_c = response.data) === null || _c === void 0 ? void 0 : _c.clientId)) {
+                        throw new errors_1.TwistRequestError('Dynamic client registration failed.', response.status, response.data);
+                    }
+                    _a = response.data, clientIdIssuedAt = _a.clientIdIssuedAt, clientSecretExpiresAt = _a.clientSecretExpiresAt, scope = _a.scope, rest = __rest(_a, ["clientIdIssuedAt", "clientSecretExpiresAt", "scope"]);
+                    return [2 /*return*/, __assign(__assign({}, rest), { scope: scope ? scope.split(' ') : undefined, clientIdIssuedAt: clientIdIssuedAt !== undefined ? new Date(clientIdIssuedAt * 1000) : undefined, clientSecretExpiresAt: clientSecretExpiresAt === undefined
+                                ? undefined
+                                : clientSecretExpiresAt === 0
+                                    ? null
+                                    : new Date(clientSecretExpiresAt * 1000) })];
+            }
+        });
+    });
+}

package/dist/esm/authentication.js

@@ -45,6 +45,17 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 import { v4 as uuid } from 'uuid';
 import { isSuccess, request } from './transport/http-client.js';
 import { TwistRequestError } from './types/errors.js';
@@ -132,9 +143,22 @@ export var TWIST_SCOPES = [
     'notifications:read',
     'notifications:write',
 ];
+/** Supported token endpoint authentication methods for dynamic client registration. */
+export var TOKEN_ENDPOINT_AUTH_METHODS = [
+    'client_secret_post',
+    'client_secret_basic',
+    'none',
+];
 export function getAuthStateParameter() {
     return uuid();
 }
+/**
+ * Generates the authorization URL for the OAuth2 flow.
+ *
+ * The `clientId` can be either a traditional client ID string (e.g. from
+ * {@link registerClient}) or an HTTPS URL pointing to a client metadata document,
+ * as defined in {@link https://drafts.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/ RFC draft-ietf-oauth-client-id-metadata-document}.
+ */
 export function getAuthorizationUrl(clientId, scopes, state, redirectUri, baseUrl) {
     if (!(scopes === null || scopes === void 0 ? void 0 : scopes.length)) {
         throw new Error('At least one scope value is required.');
@@ -207,3 +231,52 @@ export function revokeAuthToken(args, options) {
         });
     });
 }
+/**
+ * Registers a new OAuth client via Dynamic Client Registration (RFC 7591).
+ *
+ * @example
+ * ```typescript
+ * const client = await registerClient({
+ *   redirectUris: ['https://example.com/callback'],
+ *   clientName: 'My App',
+ *   scope: ['user:read', 'channels:read'],
+ * })
+ * // Use client.clientId and client.clientSecret for OAuth flows
+ * ```
+ *
+ * @returns The registered client details
+ * @throws {@link TwistRequestError} If the registration fails
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
+ */
+export function registerClient(args, options) {
+    return __awaiter(this, void 0, void 0, function () {
+        var registerUrl, response, _a, clientIdIssuedAt, clientSecretExpiresAt, scope, rest;
+        var _b, _c;
+        return __generator(this, function (_d) {
+            switch (_d.label) {
+                case 0:
+                    registerUrl = (options === null || options === void 0 ? void 0 : options.baseUrl)
+                        ? "".concat(options.baseUrl, "/oauth/register")
+                        : 'https://twist.com/oauth/register';
+                    return [4 /*yield*/, request({
+                            httpMethod: 'POST',
+                            baseUri: registerUrl,
+                            relativePath: '',
+                            payload: __assign(__assign({}, args), { scope: (_b = args.scope) === null || _b === void 0 ? void 0 : _b.join(' ') }),
+                            customFetch: options === null || options === void 0 ? void 0 : options.customFetch,
+                        })];
+                case 1:
+                    response = _d.sent();
+                    if (!isSuccess(response) || !((_c = response.data) === null || _c === void 0 ? void 0 : _c.clientId)) {
+                        throw new TwistRequestError('Dynamic client registration failed.', response.status, response.data);
+                    }
+                    _a = response.data, clientIdIssuedAt = _a.clientIdIssuedAt, clientSecretExpiresAt = _a.clientSecretExpiresAt, scope = _a.scope, rest = __rest(_a, ["clientIdIssuedAt", "clientSecretExpiresAt", "scope"]);
+                    return [2 /*return*/, __assign(__assign({}, rest), { scope: scope ? scope.split(' ') : undefined, clientIdIssuedAt: clientIdIssuedAt !== undefined ? new Date(clientIdIssuedAt * 1000) : undefined, clientSecretExpiresAt: clientSecretExpiresAt === undefined
+                                ? undefined
+                                : clientSecretExpiresAt === 0
+                                    ? null
+                                    : new Date(clientSecretExpiresAt * 1000) })];
+            }
+        });
+    });
+}

package/dist/types/authentication.d.ts

@@ -83,7 +83,78 @@ export type RevokeAuthTokenRequestArgs = {
     clientSecret: string;
     accessToken: string;
 };
+/** Supported token endpoint authentication methods for dynamic client registration. */
+export declare const TOKEN_ENDPOINT_AUTH_METHODS: readonly ["client_secret_post", "client_secret_basic", "none"];
+/**
+ * Authentication method used at the token endpoint.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591#section-2 RFC 7591 Section 2}
+ */
+export type TokenEndpointAuthMethod = (typeof TOKEN_ENDPOINT_AUTH_METHODS)[number];
+/**
+ * Parameters for registering a new OAuth client via Dynamic Client Registration.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
+ */
+export type ClientRegistrationRequest = {
+    redirectUris: string[];
+    clientName?: string;
+    clientUri?: string;
+    logoUri?: string;
+    scope?: readonly TwistScope[];
+    grantTypes?: string[];
+    responseTypes?: string[];
+    tokenEndpointAuthMethod?: TokenEndpointAuthMethod;
+};
+type RawClientRegistrationResponse = {
+    clientId: string;
+    clientSecret?: string;
+    clientName: string;
+    redirectUris: string[];
+    scope?: string;
+    grantTypes: string[];
+    responseTypes: string[];
+    tokenEndpointAuthMethod: string;
+    clientIdIssuedAt?: number;
+    clientSecretExpiresAt?: number;
+    clientUri?: string;
+    logoUri?: string;
+};
+/**
+ * Response from a successful dynamic client registration.
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591#section-3.2.1 RFC 7591 Section 3.2.1}
+ */
+export type ClientRegistrationResponse = Omit<RawClientRegistrationResponse, 'clientIdIssuedAt' | 'clientSecretExpiresAt' | 'scope'> & {
+    scope?: TwistScope[];
+    clientIdIssuedAt?: Date;
+    /** `null` indicates the client secret never expires. Absent when no secret is issued. */
+    clientSecretExpiresAt?: Date | null;
+};
 export declare function getAuthStateParameter(): string;
+/**
+ * Generates the authorization URL for the OAuth2 flow.
+ *
+ * The `clientId` can be either a traditional client ID string (e.g. from
+ * {@link registerClient}) or an HTTPS URL pointing to a client metadata document,
+ * as defined in {@link https://drafts.ietf.org/doc/draft-ietf-oauth-client-id-metadata-document/ RFC draft-ietf-oauth-client-id-metadata-document}.
+ */
 export declare function getAuthorizationUrl(clientId: string, scopes: TwistScope[], state: string, redirectUri?: string, baseUrl?: string): string;
 export declare function getAuthToken(args: AuthTokenRequestArgs, options?: AuthOptions): Promise<AuthTokenResponse>;
 export declare function revokeAuthToken(args: RevokeAuthTokenRequestArgs, options?: AuthOptions): Promise<boolean>;
+/**
+ * Registers a new OAuth client via Dynamic Client Registration (RFC 7591).
+ *
+ * @example
+ * ```typescript
+ * const client = await registerClient({
+ *   redirectUris: ['https://example.com/callback'],
+ *   clientName: 'My App',
+ *   scope: ['user:read', 'channels:read'],
+ * })
+ * // Use client.clientId and client.clientSecret for OAuth flows
+ * ```
+ *
+ * @returns The registered client details
+ * @throws {@link TwistRequestError} If the registration fails
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc7591 RFC 7591}
+ */
+export declare function registerClient(args: ClientRegistrationRequest, options?: AuthOptions): Promise<ClientRegistrationResponse>;
+export {};

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "@doist/twist-sdk",
-    "version": "2.2.0",
+    "version": "2.3.0",
     "description": "A TypeScript wrapper for the Twist REST API.",
     "author": "Doist developers",
     "homepage": "https://doist.github.io/twist-sdk-typescript/",
     "repository": "https://github.com/Doist/twist-sdk-typescript",
     "publishConfig": {
-        "registry": "https://registry.npmjs.org"
+        "access": "public",
+        "provenance": true
     },
     "license": "MIT",
     "type": "module",
@@ -33,13 +34,8 @@
         "build:post": "echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
         "build": "npm-run-all clean build:cjs build:esm build:fix-esm build:fix-dts build:post",
         "type-check": "npx tsc --noEmit",
-        "biome:sort-imports": "biome check --formatter-enabled=false --linter-enabled=false --organize-imports-enabled=true --write .",
-        "lint:check": "biome lint",
-        "lint:write": "biome lint --write",
-        "format:check": "biome format",
-        "format:write": "biome format --write",
-        "check": "biome check",
-        "check:fix": "biome check --fix --unsafe",
+        "check": "oxlint src && oxfmt --check",
+        "check:fix": "oxlint src --fix && oxfmt",
         "attw": "npx @arethetypeswrong/cli --pack --ignore-rules fallback-condition false-esm",
         "audit": "npm audit --audit-level=moderate",
         "integrity-checks": "npm-run-all clean check test build attw",
@@ -54,13 +50,18 @@
         "zod": "4.1.12"
     },
     "devDependencies": {
-        "@biomejs/biome": "2.3.4",
+        "@semantic-release/changelog": "6.0.3",
+        "@semantic-release/git": "10.0.1",
+        "conventional-changelog-conventionalcommits": "9.3.0",
         "husky": "9.1.7",
         "lint-staged": "16.2.6",
         "msw": "^2.11.3",
         "npm-run-all2": "8.0.4",
         "obsidian": "^1.10.2-1",
+        "oxfmt": "0.43.0",
+        "oxlint": "1.58.0",
         "rimraf": "6.1.0",
+        "semantic-release": "25.0.3",
         "ts-node": "10.9.2",
         "type-fest": "^5.0.0",
         "typescript": "5.9.3",
@@ -75,9 +76,8 @@
         }
     },
     "lint-staged": {
-        "*": [
-            "biome check --write --no-errors-on-unmatched --files-ignore-unknown=true"
-        ]
+        "*.{ts,tsx}": "oxlint --fix",
+        "*.{ts,tsx,json,md,yml,yaml}": "oxfmt --no-error-on-unmatched-pattern"
     },
     "files": [
         "dist/cjs/**/*",