@n8n/api-types 0.24.1 → 0.26.0

package/dist/schemas/insights.schema.d.ts

@@ -205,7 +205,6 @@ export declare const insightsByWorkflowDataSchemas: {
         averageRunTime: z.ZodNumber;
         timeSaved: z.ZodNumber;
     }, "strict", z.ZodTypeAny, {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -213,11 +212,11 @@ export declare const insightsByWorkflowDataSchemas: {
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
     }, {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -225,6 +224,7 @@ export declare const insightsByWorkflowDataSchemas: {
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
@@ -245,7 +245,6 @@ export declare const insightsByWorkflowSchema: z.ZodObject<{
         averageRunTime: z.ZodNumber;
         timeSaved: z.ZodNumber;
     }, "strict", z.ZodTypeAny, {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -253,11 +252,11 @@ export declare const insightsByWorkflowSchema: z.ZodObject<{
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
     }, {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -265,13 +264,14 @@ export declare const insightsByWorkflowSchema: z.ZodObject<{
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
     }>, "many">;
 }, "strict", z.ZodTypeAny, {
+    count: number;
     data: {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -279,14 +279,14 @@ export declare const insightsByWorkflowSchema: z.ZodObject<{
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
     }[];
-    count: number;
 }, {
+    count: number;
     data: {
-        projectId: string;
         total: number;
         failed: number;
         failureRate: number;
@@ -294,11 +294,11 @@ export declare const insightsByWorkflowSchema: z.ZodObject<{
         averageRunTime: number;
         workflowId: string;
         workflowName: string;
+        projectId: string;
         projectName: string;
         succeeded: number;
         runTime: number;
     }[];
-    count: number;
 }>;
 export type InsightsByWorkflow = z.infer<typeof insightsByWorkflowSchema>;
 export declare const insightsByTimeDataSchemas: {
@@ -372,3 +372,18 @@ export declare const insightsByTimeSchema: z.ZodObject<{
     date: string;
 }>;
 export type InsightsByTime = z.infer<typeof insightsByTimeSchema>;
+export declare const INSIGHTS_DATE_RANGE_KEYS: readonly ["day", "week", "2weeks", "month", "quarter", "6months", "year"];
+export declare const insightsDateRangeSchema: z.ZodObject<{
+    key: z.ZodEnum<["day", "week", "2weeks", "month", "quarter", "6months", "year"]>;
+    licensed: z.ZodBoolean;
+    granularity: z.ZodEnum<["hour", "day", "week"]>;
+}, "strict", z.ZodTypeAny, {
+    key: "day" | "week" | "2weeks" | "month" | "quarter" | "6months" | "year";
+    licensed: boolean;
+    granularity: "day" | "week" | "hour";
+}, {
+    key: "day" | "week" | "2weeks" | "month" | "quarter" | "6months" | "year";
+    licensed: boolean;
+    granularity: "day" | "week" | "hour";
+}>;
+export type InsightsDateRange = z.infer<typeof insightsDateRangeSchema>;

package/dist/schemas/insights.schema.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.insightsByTimeSchema = exports.insightsByTimeDataSchemas = exports.insightsByWorkflowSchema = exports.insightsByWorkflowDataSchemas = exports.insightsSummarySchema = exports.insightsSummaryDataSchemas = exports.insightsSummaryUnitSchema = exports.insightsSummaryTypeSchema = void 0;
+exports.insightsDateRangeSchema = exports.INSIGHTS_DATE_RANGE_KEYS = exports.insightsByTimeSchema = exports.insightsByTimeDataSchemas = exports.insightsByWorkflowSchema = exports.insightsByWorkflowDataSchemas = exports.insightsSummarySchema = exports.insightsSummaryDataSchemas = exports.insightsSummaryUnitSchema = exports.insightsSummaryTypeSchema = void 0;
 const zod_1 = require("zod");
 exports.insightsSummaryTypeSchema = zod_1.z.enum([
     'total',
@@ -73,4 +73,20 @@ exports.insightsByTimeDataSchemas = {
         .strict(),
 };
 exports.insightsByTimeSchema = zod_1.z.object(exports.insightsByTimeDataSchemas).strict();
+exports.INSIGHTS_DATE_RANGE_KEYS = [
+    'day',
+    'week',
+    '2weeks',
+    'month',
+    'quarter',
+    '6months',
+    'year',
+];
+exports.insightsDateRangeSchema = zod_1.z
+    .object({
+    key: zod_1.z.enum(exports.INSIGHTS_DATE_RANGE_KEYS),
+    licensed: zod_1.z.boolean(),
+    granularity: zod_1.z.enum(['hour', 'day', 'week']),
+})
+    .strict();
 //# sourceMappingURL=insights.schema.js.map

package/dist/schemas/insights.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"insights.schema.js","sourceRoot":"","sources":["../../src/schemas/insights.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,yBAAyB,GAAG,OAAC,CAAC,IAAI,CAAC;IAC/C,OAAO;IACP,QAAQ;IACR,aAAa;IACb,WAAW;IACX,gBAAgB;CAChB,CAAC,CAAC;AAGU,QAAA,yBAAyB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGhF,QAAA,0BAA0B,GAAG;IACzC,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC;QACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;QAChB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;QACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,OAAC,CAAC,MAAM,CAAC;QACnB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;KACzB,CAAC;IACF,cAAc,EAAE,OAAC,CAAC,MAAM,CAAC;QACxB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,aAAa,CAAC;KAC9B,CAAC;CACO,CAAC;AAEE,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC,kCAA0B,CAAC,CAAC,MAAM,EAAE,CAAC;AAGtE,QAAA,6BAA6B,GAAG;IAC5C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,OAAC,CAAC,KAAK,CACZ,OAAC;SACC,MAAM,CAAC;QACP,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;QACtB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;QACxB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;QACnB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;QAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC;SACD,MAAM,EAAE,CACV;CACQ,CAAC;AAEE,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC,qCAA6B,CAAC,CAAC,MAAM,EAAE,CAAC;AAG5E,QAAA,yBAAyB,GAAG;IACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,EAAE;QAChG,OAAO,EAAE,8CAA8C;KACvD,CAAC;IACF,MAAM,EAAE,OAAC;SACP,MAAM,CAAC;QACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;QAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC;SACD,MAAM,EAAE;CACD,CAAC;AAEE,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC,iCAAyB,CAAC,CAAC,MAAM,EAAE,CAAC"}
+{"version":3,"file":"insights.schema.js","sourceRoot":"","sources":["../../src/schemas/insights.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,yBAAyB,GAAG,OAAC,CAAC,IAAI,CAAC;IAC/C,OAAO;IACP,QAAQ;IACR,aAAa;IACb,WAAW;IACX,gBAAgB;CAChB,CAAC,CAAC;AAGU,QAAA,yBAAyB,GAAG,OAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC;AAGhF,QAAA,0BAA0B,GAAG;IACzC,KAAK,EAAE,OAAC,CAAC,MAAM,CAAC;QACf,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;QAChB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;QACrB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,OAAO,CAAC;KACxB,CAAC;IACF,SAAS,EAAE,OAAC,CAAC,MAAM,CAAC;QACnB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;KACzB,CAAC;IACF,cAAc,EAAE,OAAC,CAAC,MAAM,CAAC;QACxB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,KAAK,CAAC,CAAC,OAAC,CAAC,IAAI,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAI,EAAE,OAAC,CAAC,OAAO,CAAC,aAAa,CAAC;KAC9B,CAAC;CACO,CAAC;AAEE,QAAA,qBAAqB,GAAG,OAAC,CAAC,MAAM,CAAC,kCAA0B,CAAC,CAAC,MAAM,EAAE,CAAC;AAGtE,QAAA,6BAA6B,GAAG;IAC5C,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;IACjB,IAAI,EAAE,OAAC,CAAC,KAAK,CACZ,OAAC;SACC,MAAM,CAAC;QACP,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE;QACtB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE;QACxB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;QACnB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;QAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC;SACD,MAAM,EAAE,CACV;CACQ,CAAC;AAEE,QAAA,wBAAwB,GAAG,OAAC,CAAC,MAAM,CAAC,qCAA6B,CAAC,CAAC,MAAM,EAAE,CAAC;AAG5E,QAAA,yBAAyB,GAAG;IACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,KAAK,GAAG,EAAE;QAChG,OAAO,EAAE,8CAA8C;KACvD,CAAC;IACF,MAAM,EAAE,OAAC;SACP,MAAM,CAAC;QACP,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;QACrB,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;QAClB,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;QAC1B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACrB,CAAC;SACD,MAAM,EAAE;CACD,CAAC;AACE,QAAA,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC,iCAAyB,CAAC,CAAC,MAAM,EAAE,CAAC;AAGpE,QAAA,wBAAwB,GAAG;IACvC,KAAK;IACL,MAAM;IACN,QAAQ;IACR,OAAO;IACP,SAAS;IACT,SAAS;IACT,MAAM;CACG,CAAC;AACE,QAAA,uBAAuB,GAAG,OAAC;KACtC,MAAM,CAAC;IACP,GAAG,EAAE,OAAC,CAAC,IAAI,CAAC,gCAAwB,CAAC;IACrC,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;IACrB,WAAW,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;CAC5C,CAAC;KACD,MAAM,EAAE,CAAC"}

package/dist/schemas/scopes.schema.d.ts

@@ -0,0 +1,3 @@
+import type { ApiKeyScope } from '@n8n/permissions';
+import { z } from 'zod';
+export declare const scopesSchema: z.ZodEffects<z.ZodArray<z.ZodString, "many">, ApiKeyScope[], string[]>;

package/dist/schemas/scopes.schema.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scopesSchema = void 0;
+const zod_1 = require("zod");
+exports.scopesSchema = zod_1.z
+    .array(zod_1.z
+    .string()
+    .regex(/^[a-zA-Z]+:[a-zA-Z]+$/, "Each scope must follow the format '{resource}:{scope}' with only letters (e.g., 'workflow:create')"))
+    .min(1)
+    .transform((scopes) => {
+    return scopes;
+});
+//# sourceMappingURL=scopes.schema.js.map

package/dist/schemas/scopes.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scopes.schema.js","sourceRoot":"","sources":["../../src/schemas/scopes.schema.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AAEX,QAAA,YAAY,GAAG,OAAC;KAC3B,KAAK,CACL,OAAC;KACC,MAAM,EAAE;KACR,KAAK,CACL,uBAAuB,EACvB,oGAAoG,CACpG,CACF;KACA,GAAG,CAAC,CAAC,CAAC;KACN,SAAS,CAAC,CAAC,MAAM,EAAE,EAAE;IACrB,OAAO,MAAuB,CAAC;AAChC,CAAC,CAAC,CAAC"}

package/dist/schemas/source-controlled-file.schema.d.ts

@@ -13,22 +13,22 @@ export declare const SourceControlledFileSchema: z.ZodObject<{
     updatedAt: z.ZodString;
     pushed: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
+    type: "workflow" | "credential" | "file" | "tags" | "variables" | "folders";
     status: "unknown" | "new" | "modified" | "deleted" | "created" | "renamed" | "conflicted" | "ignored" | "staged";
-    type: "credential" | "workflow" | "tags" | "variables" | "file" | "folders";
+    id: string;
+    file: string;
     name: string;
     location: "local" | "remote";
-    file: string;
-    id: string;
     conflict: boolean;
     updatedAt: string;
     pushed?: boolean | undefined;
 }, {
+    type: "workflow" | "credential" | "file" | "tags" | "variables" | "folders";
     status: "unknown" | "new" | "modified" | "deleted" | "created" | "renamed" | "conflicted" | "ignored" | "staged";
-    type: "credential" | "workflow" | "tags" | "variables" | "file" | "folders";
+    id: string;
+    file: string;
     name: string;
     location: "local" | "remote";
-    file: string;
-    id: string;
     conflict: boolean;
     updatedAt: string;
     pushed?: boolean | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@n8n/api-types",
-  "version": "0.24.1",
+  "version": "0.26.0",
   "main": "dist/index.js",
   "module": "src/index.ts",
   "types": "dist/index.d.ts",
@@ -10,14 +10,15 @@
     "LICENSE_EE.md"
   ],
   "devDependencies": {
-    "@n8n/typescript-config": "1.2.0",
-    "@n8n/config": "1.36.0"
+    "@n8n/config": "1.38.0",
+    "@n8n/typescript-config": "1.2.0"
   },
   "dependencies": {
     "xss": "1.0.15",
     "zod": "3.24.1",
     "zod-class": "0.0.16",
-    "n8n-workflow": "1.87.0"
+    "n8n-workflow": "1.89.0",
+    "@n8n/permissions": "0.22.0"
   },
   "license": "SEE LICENSE IN LICENSE.md",
   "homepage": "https://n8n.io",