🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more →
Sign In

@stackbit/types

Package Overview
Dependencies
Maintainers
19
Versions
322
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@stackbit/types - npm Package Compare versions

Comparing version
0.11.5-staging.1
 to
0.11.5
+81
dist/actions.d.ts
import type { ConfigDelegate } from './config-delegate';
import type { DocumentWithSource } from './content-source-document';
import type { DocumentField, DocumentModelField } from './content-source-document-fields';
import type { ModelWithSource, ObjectModel } from './models';
import type { User } from './content-source';
import type { DocumentHookBaseOptions } from './config';
import type { Field, FieldBoolean, FieldColor, FieldDate, FieldDatetime, FieldEnum, FieldHtml, FieldMarkdown, FieldModel, FieldNumber, FieldReference, FieldSlug, FieldString, FieldText, FieldUrl } from './model-fields';
export interface GlobalAction extends CommonActionParams {
type: 'global';
state?: ActionStateFunction;
handler: ActionHandlerFunction;
}
export interface BulkAction extends CommonActionParams {
type: 'bulk';
state?: ActionStateFunction;
handler: ActionHandlerFunction<{
documents: DocumentWithSource[];
}>;
}
export interface DocumentAction extends CommonActionParams {
state?: ActionStateFunction<DocumentActionCommonParams>;
handler: ActionHandlerFunction<DocumentActionCommonParams>;
}
export interface DocumentActionCommonParams {
document: DocumentWithSource;
model: ModelWithSource;
}
export interface ObjectAction extends CommonActionParams {
state?: ActionStateFunction<ObjectActionCommonParams>;
handler: ActionHandlerFunction<ObjectActionCommonParams>;
}
export interface ObjectActionCommonParams {
parentDocument: DocumentWithSource;
parentModel: ModelWithSource;
documentField: DocumentModelField;
modelField: FieldModel;
fieldPath: (string | number)[];
objectModel: ModelWithSource<ObjectModel>;
}
export interface FieldAction extends CommonActionParams {
state?: ActionStateFunction<FieldActionCommonParams>;
handler: ActionHandlerFunction<FieldActionCommonParams>;
}
export interface FieldActionCommonParams {
parentDocument: DocumentWithSource;
parentModel: ModelWithSource;
documentField?: DocumentField;
modelField: Field;
fieldPath: (string | number)[];
}
export interface CommonActionParams {
name: string;
label?: string;
icon?: string;
inputFields?: ActionInputField[];
}
export declare type ActionStateFunction<T = unknown> = (options: CommonActionStateOptions & T) => Promise<ActionState>;
export declare type ActionHandlerFunction<T = unknown> = (options: CommonActionHandlerOptions & T) => Promise<ActionResult | void>;
export declare type ActionState = 'enabled' | 'running' | 'disabled' | 'hidden';
export interface CommonActionStateOptions extends ConfigDelegate {
actionId: string;
currentLocale?: string;
currentUser?: User;
currentPageUrl?: string;
currentPageDocument?: DocumentWithSource;
}
export interface CommonActionHandlerOptions extends ConfigDelegate, Pick<DocumentHookBaseOptions, 'getContentSourceActionsForSource' | 'getUserContextForContentSourceType'> {
actionId: string;
inputData?: Record<string, any>;
currentLocale?: string;
currentUser?: User;
currentPageUrl?: string;
currentPageDocument?: DocumentWithSource;
}
export interface ActionResult {
state?: ActionState;
success?: string;
error?: string;
}
export declare type ActionInputField = FieldString | FieldUrl | FieldSlug | FieldText | FieldMarkdown | FieldHtml | FieldNumber | FieldBoolean | FieldDate | FieldDatetime | FieldColor | FieldEnum | FieldReference;
//# sourceMappingURL=actions.d.ts.map
+1
dist/actions.d.ts.map
{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AAC1F,OAAO,KAAK,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,KAAK,EACR,KAAK,EACL,YAAY,EACZ,UAAU,EACV,SAAS,EACT,aAAa,EACb,SAAS,EACT,SAAS,EACT,aAAa,EACb,UAAU,EACV,WAAW,EACX,cAAc,EACd,SAAS,EACT,WAAW,EACX,SAAS,EACT,QAAQ,EACX,MAAM,gBAAgB,CAAC;AAExB,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACpD,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,qBAAqB,CAAC;CAClC;AAED,MAAM,WAAW,UAAW,SAAQ,kBAAkB;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,qBAAqB,CAAC;QAAE,SAAS,EAAE,kBAAkB,EAAE,CAAA;KAAE,CAAC,CAAC;CACvE;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACtD,KAAK,CAAC,EAAE,mBAAmB,CAAC,0BAA0B,CAAC,CAAC;IACxD,OAAO,EAAE,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;CAC9D;AAED,MAAM,WAAW,0BAA0B;IACvC,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,EAAE,eAAe,CAAC;CAC1B;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACpD,KAAK,CAAC,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,CAAC;IACtD,OAAO,EAAE,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;CAC5D;AAED,MAAM,WAAW,wBAAwB;IACrC,cAAc,EAAE,kBAAkB,CAAC;IACnC,WAAW,EAAE,eAAe,CAAC;IAC7B,aAAa,EAAE,kBAAkB,CAAC;IAClC,UAAU,EAAE,UAAU,CAAC;IACvB,SAAS,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IAC/B,WAAW,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,WAAY,SAAQ,kBAAkB;IACnD,KAAK,CAAC,EAAE,mBAAmB,CAAC,uBAAuB,CAAC,CAAC;IACrD,OAAO,EAAE,qBAAqB,CAAC,uBAAuB,CAAC,CAAC;CAC3D;AAED,MAAM,WAAW,uBAAuB;IACpC,cAAc,EAAE,kBAAkB,CAAC;IACnC,WAAW,EAAE,eAAe,CAAC;IAC7B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,EAAE,KAAK,CAAC;IAClB,SAAS,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAC;CACpC;AAED,oBAAY,mBAAmB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,OAAO,EAAE,wBAAwB,GAAG,CAAC,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAC/G,oBAAY,qBAAqB,CAAC,CAAC,GAAG,OAAO,IAAI,CAC7C,OAAO,EAAE,0BAA0B,GAAG,CAAC,KACtC,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC;AAElC,oBAAY,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;AAExE,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC5D,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,kBAAkB,CAAC;CAC5C;AAED,MAAM,WAAW,0BACb,SAAQ,cAAc,EAClB,IAAI,CAAC,uBAAuB,EAAE,kCAAkC,GAAG,oCAAoC,CAAC;IAC5G,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mBAAmB,CAAC,EAAE,kBAAkB,CAAC;CAC5C;AAED,MAAM,WAAW,YAAY;IACzB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,gBAAgB,GACtB,WAAW,GACX,QAAQ,GACR,SAAS,GACT,SAAS,GACT,aAAa,GACb,SAAS,GACT,WAAW,GACX,YAAY,GACZ,SAAS,GACT,aAAa,GACb,UAAU,GACV,SAAS,GACT,cAAc,CAAC"}
+3
dist/actions.js
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
//# sourceMappingURL=actions.js.map
+1
dist/actions.js.map
{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":""}
+2
-2
package.json
{
"name": "@stackbit/types",
"version": "0.11.5-staging.1",
"version": "0.11.5",
"description": "Types for Stackbit config and Content Source Interface",

@@ -30,3 +30,3 @@ "main": "dist/index.js",

"homepage": "https://github.com/stackbit/stackbit#readme",
"gitHead": "def853cc38a2e46c879e1e24bf5543b76a8813c3"
"gitHead": "afbabd80773ec73d89afa7aa6cd7ab657ecdff7d"
}