@logto/cli 1.24.0 → 1.25.0

package/lib/commands/connector/utils.d.ts

@@ -24,6 +24,23 @@ type PackageMeta = {
     scope: string;
     version: string;
 };
+/**
+ * This function fetches the list of Logto official connectors from the NPM registry.
+ *
+ * @remarks
+ * This fetching logic is based on the NPM registry API.
+ * @see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search}
+ *
+ * @remarks
+ * Known limitations of the NPM registry API:
+ * 1. The `fetchList` API request performs a 'fuzzy' search using the `text` parameter with the package name prefix `@logto/connector-`, resulting in many irrelevant results (over 1000), making it difficult to filter all official connectors.
+ * 2. The `scope:logto` search qualifier does not function as intended, failing to properly filter `@logto` scope packages.
+ *
+ * To mitigate these limitations:
+ * - We replace `scope:logto` with the `maintainer:gaosun` qualifier to reduce irrelevant results, which helps in filtering official connectors.
+ * - In addition to the API search, we filter results by checking the package name prefix `@logto/connector-`.
+ * - We continue fetching pages from the registry search API until the last page, applying the above filtering logic to compile the final list of official connectors.
+ */
 export declare const fetchOfficialConnectorList: (includingCloudConnectors?: boolean) => Promise<PackageMeta[]>;
 export declare const addOfficialConnectors: (instancePath: string, includingCloudConnectors?: boolean) => Promise<void>;
 export {};

package/lib/commands/connector/utils.js

@@ -96,10 +96,28 @@ export const addConnectors = async (instancePath, packageNames) => {
     await addConnectorsToPath(cwd, packageNames);
 };
 const officialConnectorPrefix = '@logto/connector-';
+const maintainer = 'gaosun';
+/**
+ * This function fetches the list of Logto official connectors from the NPM registry.
+ *
+ * @remarks
+ * This fetching logic is based on the NPM registry API.
+ * @see {@link https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md#get-v1search}
+ *
+ * @remarks
+ * Known limitations of the NPM registry API:
+ * 1. The `fetchList` API request performs a 'fuzzy' search using the `text` parameter with the package name prefix `@logto/connector-`, resulting in many irrelevant results (over 1000), making it difficult to filter all official connectors.
+ * 2. The `scope:logto` search qualifier does not function as intended, failing to properly filter `@logto` scope packages.
+ *
+ * To mitigate these limitations:
+ * - We replace `scope:logto` with the `maintainer:gaosun` qualifier to reduce irrelevant results, which helps in filtering official connectors.
+ * - In addition to the API search, we filter results by checking the package name prefix `@logto/connector-`.
+ * - We continue fetching pages from the registry search API until the last page, applying the above filtering logic to compile the final list of official connectors.
+ */
 export const fetchOfficialConnectorList = async (includingCloudConnectors = false) => {
     const fetchList = async (from = 0, size = 20) => {
         const parameters = new URLSearchParams({
-            text: officialConnectorPrefix,
+            text: `${officialConnectorPrefix} maintainer:${maintainer}`,
             from: String(from),
             size: String(size),
         });
@@ -107,8 +125,6 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
     };
     const packages = [];
     const excludeList = ['mock', 'kit', ...conditionalArray(!includingCloudConnectors && 'logto')];
-    // The API called by `fetchList` performs a 'fuzzy' search based on the `text` parameter, which will yield many irrelevant results. We need to filter out these irrelevant results (using `name.startsWith(officialConnectorPrefix)` for filtering).
-    // Disable lint rules for business need
     // eslint-disable-next-line @silverhand/fp/no-let, @silverhand/fp/no-mutation
     for (let page = 0;; ++page) {
         // eslint-disable-next-line no-await-in-loop
@@ -117,7 +133,7 @@ export const fetchOfficialConnectorList = async (includingCloudConnectors = fals
             excludeList.every((excluded) => !name.slice(officialConnectorPrefix.length).startsWith(excluded)));
         // eslint-disable-next-line @silverhand/fp/no-mutating-methods
         packages.push(...objects.map(({ package: data }) => data));
-        if (objects.length < 20) {
+        if (rawObjects.length < 20) {
             break;
         }
     }

package/lib/connector/utils.d.ts

@@ -1,11 +1,11 @@
-import type { AllConnector, BaseConnector, ConnectorMetadata, GetConnectorConfig, GetCloudServiceClient } from '@logto/connector-kit';
+import type { AllConnector, BaseConnector, ConnectorMetadata, GetConnectorConfig, GetCloudServiceClient, GetI18nEmailTemplate, EmailConnector } from '@logto/connector-kit';
 import { ConnectorType } from '@logto/connector-kit';
 import type { BaseRoutes, Router } from '@withtyped/server';
 import type { ConnectorFactory } from './types.js';
 export declare function validateConnectorModule(connector: Partial<BaseConnector<ConnectorType>>): asserts connector is BaseConnector<ConnectorType>;
 export declare const readUrl: (url: string, baseUrl: string, type: "text" | "image") => Promise<string>;
 export declare const parseMetadata: (metadata: AllConnector["metadata"], packagePath: string) => Promise<AllConnector["metadata"]>;
-export declare const buildRawConnector: <T extends Router<any, any, BaseRoutes, string>, U extends AllConnector = AllConnector>(connectorFactory: ConnectorFactory<T, U>, getConnectorConfig?: GetConnectorConfig, getCloudServiceClient?: GetCloudServiceClient<T>) => Promise<{
+export declare const buildRawConnector: <T extends Router<any, any, BaseRoutes, string>, U extends AllConnector = AllConnector>(connectorFactory: ConnectorFactory<T, U>, getConnectorConfig?: GetConnectorConfig, getCloudServiceClient?: GetCloudServiceClient<T>, getI18nEmailTemplate?: U extends EmailConnector ? GetI18nEmailTemplate : undefined) => Promise<{
     rawConnector: U;
     rawMetadata: ConnectorMetadata;
 }>;

package/lib/connector/utils.js

@@ -51,11 +51,12 @@ export const parseMetadata = async (metadata, packagePath) => {
         configTemplate: metadata.configTemplate && (await readUrl(metadata.configTemplate, packagePath, 'text')),
     };
 };
-export const buildRawConnector = async (connectorFactory, getConnectorConfig, getCloudServiceClient) => {
+export const buildRawConnector = async (connectorFactory, getConnectorConfig, getCloudServiceClient, getI18nEmailTemplate) => {
     const { createConnector, path: packagePath } = connectorFactory;
     const rawConnector = await createConnector({
         getConfig: getConnectorConfig ?? notImplemented,
         getCloudServiceClient,
+        getI18nEmailTemplate,
     });
     validateConnectorModule(rawConnector);
     const rawMetadata = await parseMetadata(rawConnector.metadata, packagePath);

package/lib/package-json.js

@@ -1,6 +1,6 @@
 export const packageJson = {
     "name": "@logto/cli",
-    "version": "1.24.0",
+    "version": "1.25.0",
     "description": "Logto CLI.",
     "author": "Silverhand Inc. <contact@silverhand.io>",
     "homepage": "https://github.com/logto-io/logto#readme",
@@ -42,10 +42,10 @@ export const packageJson = {
         "url": "https://github.com/logto-io/logto/issues"
     },
     "dependencies": {
-        "@logto/connector-kit": "workspace:^4.1.0",
-        "@logto/core-kit": "workspace:^2.5.2",
-        "@logto/schemas": "workspace:1.24.0",
-        "@logto/shared": "workspace:^3.1.2",
+        "@logto/connector-kit": "workspace:^4.2.0",
+        "@logto/core-kit": "workspace:^2.5.4",
+        "@logto/schemas": "workspace:1.25.0",
+        "@logto/shared": "workspace:^3.1.4",
         "@silverhand/essentials": "^2.9.1",
         "@silverhand/slonik": "31.0.0-beta.2",
         "chalk": "^5.3.0",
@@ -73,14 +73,14 @@ export const packageJson = {
         "@types/sinon": "^17.0.0",
         "@types/tar": "^6.1.12",
         "@types/yargs": "^17.0.13",
-        "@vitest/coverage-v8": "^2.1.8",
+        "@vitest/coverage-v8": "^2.1.9",
         "@withtyped/server": "^0.14.0",
         "eslint": "^8.56.0",
         "lint-staged": "^15.0.0",
         "prettier": "^3.0.0",
         "sinon": "^19.0.0",
         "typescript": "^5.5.3",
-        "vitest": "^2.1.8"
+        "vitest": "^2.1.9"
     },
     "eslintConfig": {
         "extends": "@silverhand",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logto/cli",
-  "version": "1.24.0",
+  "version": "1.25.0",
   "description": "Logto CLI.",
   "author": "Silverhand Inc. <contact@silverhand.io>",
   "homepage": "https://github.com/logto-io/logto#readme",
@@ -28,10 +28,10 @@
     "url": "https://github.com/logto-io/logto/issues"
   },
   "dependencies": {
-    "@logto/connector-kit": "^4.1.0",
-    "@logto/core-kit": "^2.5.2",
-    "@logto/schemas": "1.24.0",
-    "@logto/shared": "^3.1.2",
+    "@logto/connector-kit": "^4.2.0",
+    "@logto/core-kit": "^2.5.4",
+    "@logto/schemas": "1.25.0",
+    "@logto/shared": "^3.1.4",
     "@silverhand/essentials": "^2.9.1",
     "@silverhand/slonik": "31.0.0-beta.2",
     "chalk": "^5.3.0",
@@ -59,14 +59,14 @@
     "@types/sinon": "^17.0.0",
     "@types/tar": "^6.1.12",
     "@types/yargs": "^17.0.13",
-    "@vitest/coverage-v8": "^2.1.8",
+    "@vitest/coverage-v8": "^2.1.9",
     "@withtyped/server": "^0.14.0",
     "eslint": "^8.56.0",
     "lint-staged": "^15.0.0",
     "prettier": "^3.0.0",
     "sinon": "^19.0.0",
     "typescript": "^5.5.3",
-    "vitest": "^2.1.8"
+    "vitest": "^2.1.9"
   },
   "eslintConfig": {
     "extends": "@silverhand",