Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement →
Sign In

@evoke-platform/plugin-scripts

Package Overview
Dependencies
Maintainers
2
Versions
125
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@evoke-platform/plugin-scripts - npm Package Compare versions

Comparing version
1.0.0-dev.21
 to
1.0.0-dev.22
+4
dist/__tests__/manifest/badFiles/multipleWidgets/widget.d.ts
/** @widget */
export declare function Widget1(): null;
/** @widget */
export declare function Widget2(): null;
+16
dist/__tests__/manifest/badFiles/multipleWidgets/widget.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.Widget2 = exports.Widget1 = void 0;
/** @widget */
function Widget1() {
return null;
}
exports.Widget1 = Widget1;
/** @widget */
function Widget2() {
return null;
}
exports.Widget2 = Widget2;
//# sourceMappingURL=widget.js.map
+1
dist/__tests__/man.../badFiles/multipleWidgets/widget.js.map
{"version":3,"file":"widget.js","sourceRoot":"","sources":["../../../../../src/__tests__/manifest/badFiles/multipleWidgets/widget.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;AAE/C,cAAc;AACd,SAAgB,OAAO;IACnB,OAAO,IAAI,CAAC;AAChB,CAAC;AAFD,0BAEC;AAED,cAAc;AACd,SAAgB,OAAO;IACnB,OAAO,IAAI,CAAC;AAChB,CAAC;AAFD,0BAEC"}
+3
dist/__tests__/man...dFiles/notFunctionComponent/widget.d.ts
/** @widget */
export declare class NotFunctionComponent {
}
+10
dist/__tests__/man...badFiles/notFunctionComponent/widget.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.NotFunctionComponent = void 0;
/** @widget */
class NotFunctionComponent {
}
exports.NotFunctionComponent = NotFunctionComponent;
//# sourceMappingURL=widget.js.map
+1
dist/__tests__/man...iles/notFunctionComponent/widget.js.map
{"version":3,"file":"widget.js","sourceRoot":"","sources":["../../../../../src/__tests__/manifest/badFiles/notFunctionComponent/widget.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;AAE/C,cAAc;AACd,MAAa,oBAAoB;CAAG;AAApC,oDAAoC"}
+1
dist/__tests__/manifest/scanner.unit.d.ts
export {};
+290
dist/__tests__/manifest/scanner.unit.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const chai_1 = __importStar(require("chai"));
const chai_as_promised_1 = __importDefault(require("chai-as-promised"));
const dirty_chai_1 = __importDefault(require("dirty-chai"));
const manifest_1 = require("../../manifest");
chai_1.default.use(dirty_chai_1.default).use(chai_as_promised_1.default);
const Timeout = 15000;
describe('Scanner', () => {
const scanner = new manifest_1.Scanner('src/__tests__/manifest/testFiles', { defaultVersion: '1-test' });
let widgets = {};
before(async function () {
this.timeout(Timeout);
widgets = (await scanner.scan()).widgets;
});
describe('widget', () => {
it('detects components marked with @widget', () => {
(0, chai_1.expect)(widgets['Basic']).to.eql({
id: 'Basic',
name: 'Basic',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/basic.tsx',
properties: [],
});
});
it('detects components marked with @widgetName', () => {
(0, chai_1.expect)(widgets['Basic2']).to.eql({
id: 'Basic2',
name: 'Basic2',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/basic2.tsx',
properties: [],
});
});
it('allows overriding widget id', () => {
(0, chai_1.expect)(widgets['CustomId']).to.eql({
id: 'CustomId',
name: 'CustomId',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/widgetId.tsx',
properties: [],
});
});
it('allows setting widget name', () => {
(0, chai_1.expect)(widgets['WidgetName']).to.eql({
id: 'WidgetName',
name: 'Test Widget Name',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/widgetName.tsx',
properties: [],
});
});
it('allows setting widget description', () => {
(0, chai_1.expect)(widgets['WidgetDescription']).to.eql({
id: 'WidgetDescription',
name: 'WidgetDescription',
description: 'This is a sample description for a widget. It may wrap to multiple lines.',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/description.tsx',
properties: [],
});
});
it('allows overriding version for widget', () => {
(0, chai_1.expect)(widgets['WidgetVersion']).to.eql({
id: 'WidgetVersion',
name: 'WidgetVersion',
description: '',
version: 'testVersion',
src: 'src/__tests__/manifest/testFiles/version.tsx',
properties: [],
});
});
it('fails if module contains multiple widgets', async () => {
const scanner = new manifest_1.Scanner('src/__tests__/manifest/badFiles/multipleWidgets');
await (0, chai_1.expect)(scanner.scan()).to.be.rejectedWith('Multiple @widget declarations in src/__tests__/manifest/badFiles/multipleWidgets/widget.tsx, only the default export can be declared a widget');
}).timeout(Timeout);
it('fails if @widget is not on a function', async () => {
const scanner = new manifest_1.Scanner('src/__tests__/manifest/badFiles/notFunctionComponent');
await (0, chai_1.expect)(scanner.scan()).to.be.rejectedWith('@widget must be declared on a FunctionComponent');
}).timeout(Timeout);
});
describe('props', () => {
it('detects properties through type reference', () => {
(0, chai_1.expect)(widgets['PropsTypeReference']).to.eql({
id: 'PropsTypeReference',
name: 'PropsTypeReference',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/typeReferenceProps.tsx',
properties: [
{
name: 'textProperty',
displayName: 'textProperty',
type: 'text',
optional: false,
},
],
});
});
it('detects properties on type literal', () => {
(0, chai_1.expect)(widgets['PropsTypeLiteral']).to.eql({
id: 'PropsTypeLiteral',
name: 'PropsTypeLiteral',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/typeLiteralProps.tsx',
properties: [
{
name: 'textProperty',
displayName: 'textProperty',
type: 'text',
optional: false,
},
],
});
});
xit('detects properties of intersection types', () => {
(0, chai_1.expect)(widgets['PropsIntersectionType']).to.eql({
id: 'PropsIntersectionType',
name: 'PropsIntersectionType',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/intersectionTypeProps.tsx',
properties: [
{
name: 'base',
displayName: 'base',
type: 'text',
optional: false,
},
{
name: 'textProperty',
displayName: 'textProperty',
type: 'text',
optional: false,
},
],
});
});
it('allows setting property name', () => {
(0, chai_1.expect)(widgets['PropertyName']).to.eql({
id: 'PropertyName',
name: 'PropertyName',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/propertyName.tsx',
properties: [
{
name: 'textProperty',
displayName: 'Text Property',
type: 'text',
optional: false,
},
],
});
});
it('allows overriding property type', () => {
(0, chai_1.expect)(widgets['PropertyType']).to.eql({
id: 'PropertyType',
name: 'PropertyType',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/propertyType.tsx',
properties: [
{
name: 'choicesProperty',
displayName: 'choicesProperty',
type: 'choices',
optional: false,
},
],
});
});
it('detects optional properties', () => {
(0, chai_1.expect)(widgets['OptionalProperty']).to.eql({
id: 'OptionalProperty',
name: 'OptionalProperty',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/optionalProperty.tsx',
properties: [
{
name: 'textProperty',
displayName: 'textProperty',
type: 'text',
optional: true,
},
],
});
});
it('detects properties that can be undefined', () => {
(0, chai_1.expect)(widgets['OptionalProperty2']).to.eql({
id: 'OptionalProperty2',
name: 'OptionalProperty2',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/optionalProperty2.tsx',
properties: [
{
name: 'textProperty',
displayName: 'textProperty',
type: 'text',
optional: true,
},
],
});
});
it('infers type of number properties', () => {
(0, chai_1.expect)(widgets['NumberProperty']).to.eql({
id: 'NumberProperty',
name: 'NumberProperty',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/numberProperty.tsx',
properties: [
{
name: 'numProperty',
displayName: 'numProperty',
type: 'number',
optional: false,
},
],
});
});
xit('infers type of record properties', () => {
(0, chai_1.expect)(widgets['RecordProperty']).to.eql({
id: 'RecordProperty',
name: 'RecordProperty',
description: '',
version: '1-test',
src: 'src/__tests__/manifest/testFiles/recordProperty.tsx',
properties: [
{
name: 'recordProperty',
displayName: 'recordProperty',
type: 'inputGroup',
optional: false,
inputGroup: [
{
name: 'nested1',
displayName: 'nested1',
type: 'text',
optional: false,
},
{
name: 'nested2',
displayName: 'nested2',
type: 'number',
optional: false,
},
],
},
],
});
});
});
});
//# sourceMappingURL=scanner.unit.js.map
+1
dist/__tests__/manifest/scanner.unit.js.map
{"version":3,"file":"scanner.unit.js","sourceRoot":"","sources":["../../../src/__tests__/manifest/scanner.unit.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE/C,6CAAoC;AACpC,wEAA8C;AAC9C,4DAAmC;AAEnC,6CAA2D;AAE3D,cAAI,CAAC,GAAG,CAAC,oBAAS,CAAC,CAAC,GAAG,CAAC,0BAAc,CAAC,CAAC;AAExC,MAAM,OAAO,GAAG,KAAK,CAAC;AAEtB,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC,kCAAkC,EAAE,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC9F,IAAI,OAAO,GAAiC,EAAE,CAAC;IAE/C,MAAM,CAAC,KAAK;QACR,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEtB,OAAO,GAAG,CAAC,MAAM,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACpB,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAC9C,IAAA,aAAM,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC5B,EAAE,EAAE,OAAO;gBACX,IAAI,EAAE,OAAO;gBACb,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,4CAA4C;gBACjD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YAClD,IAAA,aAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC7B,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,6CAA6C;gBAClD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACnC,IAAA,aAAM,EAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC/B,EAAE,EAAE,UAAU;gBACd,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,+CAA+C;gBACpD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YAClC,IAAA,aAAM,EAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACjC,EAAE,EAAE,YAAY;gBAChB,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,iDAAiD;gBACtD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;YACzC,IAAA,aAAM,EAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACxC,EAAE,EAAE,mBAAmB;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,WAAW,EAAE,2EAA2E;gBACxF,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,kDAAkD;gBACvD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC5C,IAAA,aAAM,EAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACpC,EAAE,EAAE,eAAe;gBACnB,IAAI,EAAE,eAAe;gBACrB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,aAAa;gBACtB,GAAG,EAAE,8CAA8C;gBACnD,UAAU,EAAE,EAAE;aACjB,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC,iDAAiD,CAAC,CAAC;YAE/E,MAAM,IAAA,aAAM,EAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAC3C,+IAA+I,CAClJ,CAAC;QACN,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEpB,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,kBAAO,CAAC,sDAAsD,CAAC,CAAC;YAEpF,MAAM,IAAA,aAAM,EAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,iDAAiD,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACnB,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACjD,IAAA,aAAM,EAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACzC,EAAE,EAAE,oBAAoB;gBACxB,IAAI,EAAE,oBAAoB;gBAC1B,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,yDAAyD;gBAC9D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,cAAc;wBAC3B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC1C,IAAA,aAAM,EAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACvC,EAAE,EAAE,kBAAkB;gBACtB,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,uDAAuD;gBAC5D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,cAAc;wBAC3B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,0CAA0C,EAAE,GAAG,EAAE;YACjD,IAAA,aAAM,EAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBAC5C,EAAE,EAAE,uBAAuB;gBAC3B,IAAI,EAAE,uBAAuB;gBAC7B,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,4DAA4D;gBACjE,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,MAAM;wBACZ,WAAW,EAAE,MAAM;wBACnB,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,KAAK;qBAClB;oBACD;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,cAAc;wBAC3B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACpC,IAAA,aAAM,EAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACnC,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,mDAAmD;gBACxD,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,eAAe;wBAC5B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACvC,IAAA,aAAM,EAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACnC,EAAE,EAAE,cAAc;gBAClB,IAAI,EAAE,cAAc;gBACpB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,mDAAmD;gBACxD,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,iBAAiB;wBACvB,WAAW,EAAE,iBAAiB;wBAC9B,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACnC,IAAA,aAAM,EAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACvC,EAAE,EAAE,kBAAkB;gBACtB,IAAI,EAAE,kBAAkB;gBACxB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,uDAAuD;gBAC5D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,cAAc;wBAC3B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,IAAI;qBACjB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAChD,IAAA,aAAM,EAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACxC,EAAE,EAAE,mBAAmB;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,wDAAwD;gBAC7D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,cAAc;wBACpB,WAAW,EAAE,cAAc;wBAC3B,IAAI,EAAE,MAAM;wBACZ,QAAQ,EAAE,IAAI;qBACjB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YACxC,IAAA,aAAM,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACrC,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,gBAAgB;gBACtB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qDAAqD;gBAC1D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,aAAa;wBACnB,WAAW,EAAE,aAAa;wBAC1B,IAAI,EAAE,QAAQ;wBACd,QAAQ,EAAE,KAAK;qBAClB;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,kCAAkC,EAAE,GAAG,EAAE;YACzC,IAAA,aAAM,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC;gBACrC,EAAE,EAAE,gBAAgB;gBACpB,IAAI,EAAE,gBAAgB;gBACtB,WAAW,EAAE,EAAE;gBACf,OAAO,EAAE,QAAQ;gBACjB,GAAG,EAAE,qDAAqD;gBAC1D,UAAU,EAAE;oBACR;wBACI,IAAI,EAAE,gBAAgB;wBACtB,WAAW,EAAE,gBAAgB;wBAC7B,IAAI,EAAE,YAAY;wBAClB,QAAQ,EAAE,KAAK;wBACf,UAAU,EAAE;4BACR;gCACI,IAAI,EAAE,SAAS;gCACf,WAAW,EAAE,SAAS;gCACtB,IAAI,EAAE,MAAM;gCACZ,QAAQ,EAAE,KAAK;6BAClB;4BACD;gCACI,IAAI,EAAE,SAAS;gCACf,WAAW,EAAE,SAAS;gCACtB,IAAI,EAAE,QAAQ;gCACd,QAAQ,EAAE,KAAK;6BAClB;yBACJ;qBACJ;iBACJ;aACJ,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
+3
dist/__tests__/manifest/testFiles/basic.d.ts
/** @widget */
declare function Basic(): null;
export default Basic;
+10
dist/__tests__/manifest/testFiles/basic.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function Basic() {
return null;
}
exports.default = Basic;
//# sourceMappingURL=basic.js.map
+1
dist/__tests__/manifest/testFiles/basic.js.map
{"version":3,"file":"basic.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/basic.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C,cAAc;AACd,SAAS,KAAK;IACV,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,KAAK,CAAC"}
+3
dist/__tests__/manifest/testFiles/basic2.d.ts
/** @widgetName */
declare function Basic2(): null;
export default Basic2;
+10
dist/__tests__/manifest/testFiles/basic2.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widgetName */
function Basic2() {
return null;
}
exports.default = Basic2;
//# sourceMappingURL=basic2.js.map
+1
dist/__tests__/manifest/testFiles/basic2.js.map
{"version":3,"file":"basic2.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/basic2.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C,kBAAkB;AAClB,SAAS,MAAM;IACX,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,MAAM,CAAC"}
+8
dist/__tests__/manifest/testFiles/description.d.ts
/**
* This is a sample description for a widget. It may wrap to
* multiple lines.
*
* @widget
*/
declare function WidgetDescription(): null;
export default WidgetDescription;
+15
dist/__tests__/manifest/testFiles/description.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/**
* This is a sample description for a widget. It may wrap to
* multiple lines.
*
* @widget
*/
function WidgetDescription() {
return null;
}
exports.default = WidgetDescription;
//# sourceMappingURL=description.js.map
+1
dist/__tests__/manifest/testFiles/description.js.map
{"version":3,"file":"description.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/description.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C;;;;;GAKG;AACH,SAAS,iBAAiB;IACtB,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,iBAAiB,CAAC"}
+9
dist/__tests__/manifest/testFiles/intersectionTypeProps.d.ts
type BaseType = {
base: string;
};
type PropsType = BaseType & {
textProperty: string;
};
/** @widget */
declare function PropsIntersectionType(props: PropsType): null;
export default PropsIntersectionType;
+10
dist/__tests__/manifest/testFiles/intersectionTypeProps.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function PropsIntersectionType(props) {
return null;
}
exports.default = PropsIntersectionType;
//# sourceMappingURL=intersectionTypeProps.js.map
+1
dist/__tests__/man.../testFiles/intersectionTypeProps.js.map
{"version":3,"file":"intersectionTypeProps.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/intersectionTypeProps.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAU/C,cAAc;AACd,SAAS,qBAAqB,CAAC,KAAgB;IAC3C,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,qBAAqB,CAAC"}
+6
dist/__tests__/manifest/testFiles/numberProperty.d.ts
type PropsType = {
numProperty: number;
};
/** @widget */
declare function NumberProperty(props: PropsType): null;
export default NumberProperty;
+10
dist/__tests__/manifest/testFiles/numberProperty.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function NumberProperty(props) {
return null;
}
exports.default = NumberProperty;
//# sourceMappingURL=numberProperty.js.map
+1
dist/__tests__/manifest/testFiles/numberProperty.js.map
{"version":3,"file":"numberProperty.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/numberProperty.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAM/C,cAAc;AACd,SAAS,cAAc,CAAC,KAAgB;IACpC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,cAAc,CAAC"}
+6
dist/__tests__/manifest/testFiles/optionalProperty.d.ts
type PropsType = {
textProperty?: string;
};
/** @widget */
declare function OptionalProperty(props: PropsType): null;
export default OptionalProperty;
+10
dist/__tests__/manifest/testFiles/optionalProperty.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function OptionalProperty(props) {
return null;
}
exports.default = OptionalProperty;
//# sourceMappingURL=optionalProperty.js.map
+1
dist/__tests__/manifest/testFiles/optionalProperty.js.map
{"version":3,"file":"optionalProperty.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/optionalProperty.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAM/C,cAAc;AACd,SAAS,gBAAgB,CAAC,KAAgB;IACtC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,gBAAgB,CAAC"}
+6
dist/__tests__/manifest/testFiles/optionalProperty2.d.ts
type PropsType = {
textProperty: string | undefined;
};
/** @widget */
declare function OptionalProperty2(props: PropsType): null;
export default OptionalProperty2;
+10
dist/__tests__/manifest/testFiles/optionalProperty2.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function OptionalProperty2(props) {
return null;
}
exports.default = OptionalProperty2;
//# sourceMappingURL=optionalProperty2.js.map
+1
dist/__tests__/manifest/testFiles/optionalProperty2.js.map
{"version":3,"file":"optionalProperty2.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/optionalProperty2.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAM/C,cAAc;AACd,SAAS,iBAAiB,CAAC,KAAgB;IACvC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,iBAAiB,CAAC"}
+9
dist/__tests__/manifest/testFiles/propertyName.d.ts
type PropsType = {
/**
* @propertyName Text Property
*/
textProperty: string;
};
/** @widget */
declare function PropertyName(props: PropsType): null;
export default PropertyName;
+10
dist/__tests__/manifest/testFiles/propertyName.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function PropertyName(props) {
return null;
}
exports.default = PropertyName;
//# sourceMappingURL=propertyName.js.map
+1
dist/__tests__/manifest/testFiles/propertyName.js.map
{"version":3,"file":"propertyName.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/propertyName.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAS/C,cAAc;AACd,SAAS,YAAY,CAAC,KAAgB;IAClC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,YAAY,CAAC"}
+9
dist/__tests__/manifest/testFiles/propertyType.d.ts
type PropsType = {
/**
* @propertyType choices
*/
choicesProperty: string;
};
/** @widget */
declare function PropertyType(props: PropsType): null;
export default PropertyType;
+10
dist/__tests__/manifest/testFiles/propertyType.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function PropertyType(props) {
return null;
}
exports.default = PropertyType;
//# sourceMappingURL=propertyType.js.map
+1
dist/__tests__/manifest/testFiles/propertyType.js.map
{"version":3,"file":"propertyType.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/propertyType.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAS/C,cAAc;AACd,SAAS,YAAY,CAAC,KAAgB;IAClC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,YAAY,CAAC"}
+9
dist/__tests__/manifest/testFiles/recordProperty.d.ts
type PropsType = {
recordProperty: {
nested1: string;
nested2: number;
};
};
/** @widget */
declare function RecordProperty(props: PropsType): null;
export default RecordProperty;
+10
dist/__tests__/manifest/testFiles/recordProperty.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function RecordProperty(props) {
return null;
}
exports.default = RecordProperty;
//# sourceMappingURL=recordProperty.js.map
+1
dist/__tests__/manifest/testFiles/recordProperty.js.map
{"version":3,"file":"recordProperty.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/recordProperty.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAS/C,cAAc;AACd,SAAS,cAAc,CAAC,KAAgB;IACpC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,cAAc,CAAC"}
+5
dist/__tests__/manifest/testFiles/typeLiteralProps.d.ts
/** @widget */
declare function PropsTypeLiteral(props: {
textProperty: string;
}): null;
export default PropsTypeLiteral;
+10
dist/__tests__/manifest/testFiles/typeLiteralProps.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function PropsTypeLiteral(props) {
return null;
}
exports.default = PropsTypeLiteral;
//# sourceMappingURL=typeLiteralProps.js.map
+1
dist/__tests__/manifest/testFiles/typeLiteralProps.js.map
{"version":3,"file":"typeLiteralProps.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/typeLiteralProps.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C,cAAc;AACd,SAAS,gBAAgB,CAAC,KAA+B;IACrD,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,gBAAgB,CAAC"}
+6
dist/__tests__/manifest/testFiles/typeReferenceProps.d.ts
type PropsType = {
textProperty: string;
};
/** @widget */
declare function PropsTypeReference(props: PropsType): null;
export default PropsTypeReference;
+10
dist/__tests__/manifest/testFiles/typeReferenceProps.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget */
function PropsTypeReference(props) {
return null;
}
exports.default = PropsTypeReference;
//# sourceMappingURL=typeReferenceProps.js.map
+1
dist/__tests__/manifest/testFiles/typeReferenceProps.js.map
{"version":3,"file":"typeReferenceProps.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/typeReferenceProps.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAM/C,cAAc;AACd,SAAS,kBAAkB,CAAC,KAAgB;IACxC,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,kBAAkB,CAAC"}
+6
dist/__tests__/manifest/testFiles/version.d.ts
/**
* @widget
* @widgetVersion testVersion
* */
declare function WidgetVersion(): null;
export default WidgetVersion;
+13
dist/__tests__/manifest/testFiles/version.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/**
* @widget
* @widgetVersion testVersion
* */
function WidgetVersion() {
return null;
}
exports.default = WidgetVersion;
//# sourceMappingURL=version.js.map
+1
dist/__tests__/manifest/testFiles/version.js.map
{"version":3,"file":"version.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/version.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C;;;KAGK;AACL,SAAS,aAAa;IAClB,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,aAAa,CAAC"}
+3
dist/__tests__/manifest/testFiles/widgetId.d.ts
/** @widget CustomId */
declare function Widget(): null;
export default Widget;
+10
dist/__tests__/manifest/testFiles/widgetId.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widget CustomId */
function Widget() {
return null;
}
exports.default = Widget;
//# sourceMappingURL=widgetId.js.map
+1
dist/__tests__/manifest/testFiles/widgetId.js.map
{"version":3,"file":"widgetId.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/widgetId.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C,uBAAuB;AACvB,SAAS,MAAM;IACX,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,MAAM,CAAC"}
+3
dist/__tests__/manifest/testFiles/widgetName.d.ts
/** @widgetName Test Widget Name */
declare function WidgetName(): null;
export default WidgetName;
+10
dist/__tests__/manifest/testFiles/widgetName.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/** @widgetName Test Widget Name */
function WidgetName() {
return null;
}
exports.default = WidgetName;
//# sourceMappingURL=widgetName.js.map
+1
dist/__tests__/manifest/testFiles/widgetName.js.map
{"version":3,"file":"widgetName.js","sourceRoot":"","sources":["../../../../src/__tests__/manifest/testFiles/widgetName.tsx"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;AAE/C,mCAAmC;AACnC,SAAS,UAAU;IACf,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,kBAAe,UAAU,CAAC"}
+1
dist/index.d.ts
export * from './manifest';
+20
dist/index.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./manifest"), exports);
//# sourceMappingURL=index.js.map
+1
dist/index.js.map
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;;;;;;;;;;;AAE/C,6CAA2B"}
+3
dist/manifest/debug.d.ts
import _debug from 'debug';
declare const debug: _debug.Debugger;
export default debug;
+11
dist/manifest/debug.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const debug_1 = __importDefault(require("debug"));
const debug = (0, debug_1.default)('plugin-scripts:manifest');
exports.default = debug;
//# sourceMappingURL=debug.js.map
+1
dist/manifest/debug.js.map
{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../src/manifest/debug.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;AAE/C,kDAA2B;AAE3B,MAAM,KAAK,GAAG,IAAA,eAAM,EAAC,yBAAyB,CAAC,CAAC;AAEhD,kBAAe,KAAK,CAAC"}
+15
dist/manifest/descriptors.d.ts
export type WidgetDescriptor = {
id: string;
name: string;
description?: string;
version?: string;
src: string;
properties: WidgetPropertyDescriptor[];
};
export type WidgetPropertyDescriptor = {
name: string;
displayName?: string;
type: string;
isOptional?: boolean;
[key: string]: unknown;
};
+5
dist/manifest/descriptors.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
//# sourceMappingURL=descriptors.js.map
+1
dist/manifest/descriptors.js.map
{"version":3,"file":"descriptors.js","sourceRoot":"","sources":["../../src/manifest/descriptors.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C"}
+5
dist/manifest/errors.d.ts
import { Node } from 'typescript';
export declare function locationString(compilerNode: Node): string;
export declare class SyntaxError extends Error {
constructor(message: string, compilerNode: Node);
}
+18
dist/manifest/errors.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
exports.SyntaxError = exports.locationString = void 0;
function locationString(compilerNode) {
const sourceFile = compilerNode.getSourceFile();
const location = sourceFile.getLineAndCharacterOfPosition(compilerNode.pos);
return `${sourceFile.fileName}(${location.line + 1},${location.character + 1})`;
}
exports.locationString = locationString;
class SyntaxError extends Error {
constructor(message, compilerNode) {
super(`${locationString(compilerNode)}: ${message}`);
}
}
exports.SyntaxError = SyntaxError;
//# sourceMappingURL=errors.js.map
+1
dist/manifest/errors.js.map
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/manifest/errors.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;AAI/C,SAAgB,cAAc,CAAC,YAAkB;IAC7C,MAAM,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;IAChD,MAAM,QAAQ,GAAG,UAAU,CAAC,6BAA6B,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;IAE5E,OAAO,GAAG,UAAU,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,IAAI,QAAQ,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC;AACpF,CAAC;AALD,wCAKC;AAED,MAAa,WAAY,SAAQ,KAAK;IAClC,YAAY,OAAe,EAAE,YAAkB;QAC3C,KAAK,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,KAAK,OAAO,EAAE,CAAC,CAAC;IACzD,CAAC;CACJ;AAJD,kCAIC"}
+22
dist/manifest/fileScanner.d.ts
import { Program } from 'typescript';
import { WidgetDescriptor } from './descriptors';
export type FileScannerOptions = {
defaultVersion?: string;
};
export declare class FileScanner {
private program;
private file;
private options?;
private parsedSource;
constructor(program: Program, file: string, options?: FileScannerOptions | undefined);
scanForWidget(): WidgetDescriptor | undefined;
private hasWidgetModifier;
private getTagValue;
private processWidget;
private processProperties;
private getPropertyComment;
private determinePropertyType;
private determineBaseType;
private isPropertyOptional;
private getPropsType;
}
+184
dist/manifest/fileScanner.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FileScanner = void 0;
const typescript_1 = require("typescript");
const debug_1 = __importDefault(require("./debug"));
const errors_1 = require("./errors");
const parser_1 = require("./parser");
class FileScanner {
constructor(program, file, options) {
this.program = program;
this.file = file;
this.options = options;
}
scanForWidget() {
const parsed = (0, parser_1.parseFile)(this.program, this.file);
let widget;
if (parsed) {
this.parsedSource = parsed;
const widgetDeclarations = parsed.comments.filter(this.hasWidgetModifier);
if (widgetDeclarations.length > 1) {
throw new errors_1.SyntaxError(`Multiple @widget declarations in ${this.file}, only the default export can be declared a widget`, widgetDeclarations[1].compilerNode);
}
else if (widgetDeclarations.length === 1) {
(0, debug_1.default)('found @widget declaration in %s', this.file);
widget = this.processWidget(widgetDeclarations[0]);
}
}
return widget;
}
hasWidgetModifier(comment) {
return comment.commentBlock.tags.some((tag) => tag.tag === 'widget' || tag.tag === 'widgetName');
}
getTagValue(tags, tagName, fullText) {
const tag = tags.find((tag) => tag.tag === tagName);
if (!tag) {
return undefined;
}
const nameComponents = [tag.name];
if (fullText && tag.description) {
nameComponents.push(tag.description);
}
return nameComponents.join(' ');
}
processWidget(widgetDeclaration) {
if (widgetDeclaration.compilerNode.kind !== typescript_1.SyntaxKind.FunctionDeclaration) {
throw new errors_1.SyntaxError('@widget must be declared on a FunctionComponent', widgetDeclaration.compilerNode);
}
const funcDeclaration = widgetDeclaration.compilerNode;
const tags = widgetDeclaration.commentBlock.tags;
const widgetId = this.getTagValue(tags, 'widget') || funcDeclaration.name?.text;
if (!widgetId) {
throw new errors_1.SyntaxError('Unable to determine widget id, no explicit id provided and unable to determine function name', funcDeclaration);
}
const widgetName = this.getTagValue(tags, 'widgetName', true) || widgetId;
const widgetVersion = this.getTagValue(tags, 'widgetVersion') || this.options?.defaultVersion;
const widget = {
id: widgetId,
name: widgetName,
description: widgetDeclaration.commentBlock.description,
version: widgetVersion,
src: this.file,
properties: [],
};
const propsType = this.getPropsType(funcDeclaration);
if (propsType) {
widget.properties = this.processProperties(propsType);
}
return widget;
}
processProperties(propsType) {
const properties = [];
for (const member of propsType.members) {
const name = member.name;
if (!name) {
throw new errors_1.SyntaxError('Property has no name', member);
}
if (!('text' in name)) {
throw new errors_1.SyntaxError('Unable to determine property id', member);
}
const comment = this.getPropertyComment(member);
const tags = comment?.commentBlock.tags ?? [];
const propertyId = name.text;
const propertyName = this.getTagValue(tags, 'propertyName', true) || propertyId;
const propertyType = this.getTagValue(tags, 'propertyType') || this.determinePropertyType(propertyId, member);
properties.push({
name: propertyId,
displayName: propertyName,
type: propertyType,
optional: this.isPropertyOptional(member),
});
}
return properties;
}
getPropertyComment(property) {
return this.parsedSource?.comments?.find((comment) => comment.compilerNode === property);
}
determinePropertyType(id, property) {
// Default to text unless we can determine a better type;
let type = 'text';
const baseType = this.determineBaseType(property);
switch (baseType?.kind) {
case typescript_1.SyntaxKind.StringKeyword:
type = 'text';
break;
case typescript_1.SyntaxKind.NumberKeyword:
type = 'number';
break;
case typescript_1.SyntaxKind.BooleanKeyword:
type = 'boolean';
break;
default:
console.log(`${(0, errors_1.locationString)(property)}: not able to infer type for property ${id}, defaulting to 'text'`);
break;
}
return type;
}
determineBaseType(property) {
let typeNode;
if (property.kind === typescript_1.SyntaxKind.PropertySignature) {
typeNode = property.type;
}
if (typeNode?.kind === typescript_1.SyntaxKind.UnionType) {
const unionType = typeNode;
// Remove undefined and null.
const types = unionType.types.filter((type) => type.kind !== typescript_1.SyntaxKind.UndefinedKeyword && type.kind !== typescript_1.SyntaxKind.NullKeyword);
if (types.length === 1) {
typeNode = types[0];
}
else {
(0, debug_1.default)('');
}
}
return typeNode;
}
isPropertyOptional(property) {
if (property.questionToken) {
return true;
}
if (property.kind === typescript_1.SyntaxKind.PropertySignature) {
const typeNode = property.type;
if (typeNode?.kind === typescript_1.SyntaxKind.UnionType) {
const unionType = typeNode;
return unionType.types.some((type) => type.kind === typescript_1.SyntaxKind.UndefinedKeyword);
}
}
return false;
}
getPropsType(funcDeclaration) {
const propsParam = funcDeclaration.parameters[0];
let propsType;
switch (propsParam?.type?.kind) {
case typescript_1.SyntaxKind.TypeLiteral:
propsType = propsParam.type;
break;
case typescript_1.SyntaxKind.TypeReference: {
const name = propsParam.type.typeName;
if ('text' in name) {
propsType = this.parsedSource?.types[name.text];
}
else {
throw new errors_1.SyntaxError('Unable to determine widget props type (qualified type references not supported)', propsParam.type);
}
break;
}
default:
if (propsParam?.type?.kind) {
throw new errors_1.SyntaxError(`Unable to determine widget props type from ${typescript_1.SyntaxKind[propsParam.type.kind]}`, propsParam.type);
}
// Only an error if there is a parameter.
if (propsParam) {
throw new errors_1.SyntaxError('No type specified for widget props', propsParam);
}
break;
}
return propsType;
}
}
exports.FileScanner = FileScanner;
//# sourceMappingURL=fileScanner.js.map
+1
dist/manifest/fileScanner.js.map
{"version":3,"file":"fileScanner.js","sourceRoot":"","sources":["../../src/manifest/fileScanner.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;AAG/C,2CAUoB;AACpB,oDAA4B;AAE5B,qCAAuD;AACvD,qCAA4D;AAM5D,MAAa,WAAW;IAGpB,YAAoB,OAAgB,EAAU,IAAY,EAAU,OAA4B;QAA5E,YAAO,GAAP,OAAO,CAAS;QAAU,SAAI,GAAJ,IAAI,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAqB;IAAG,CAAC;IAEpG,aAAa;QACT,MAAM,MAAM,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,MAAoC,CAAC;QAEzC,IAAI,MAAM,EAAE;YACR,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;YAE3B,MAAM,kBAAkB,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAE1E,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC/B,MAAM,IAAI,oBAAW,CACjB,oCAAoC,IAAI,CAAC,IAAI,oDAAoD,EACjG,kBAAkB,CAAC,CAAC,CAAC,CAAC,YAAY,CACrC,CAAC;aACL;iBAAM,IAAI,kBAAkB,CAAC,MAAM,KAAK,CAAC,EAAE;gBACxC,IAAA,eAAK,EAAC,iCAAiC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAEpD,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;aACtD;SACJ;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,iBAAiB,CAAC,OAAgB;QACtC,OAAO,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC;IACrG,CAAC;IAEO,WAAW,CAAC,IAAY,EAAE,OAAe,EAAE,QAAkB;QACjE,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,OAAO,CAAC,CAAC;QAEpD,IAAI,CAAC,GAAG,EAAE;YACN,OAAO,SAAS,CAAC;SACpB;QAED,MAAM,cAAc,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAElC,IAAI,QAAQ,IAAI,GAAG,CAAC,WAAW,EAAE;YAC7B,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;SACxC;QAED,OAAO,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAEO,aAAa,CAAC,iBAA0B;QAC5C,IAAI,iBAAiB,CAAC,YAAY,CAAC,IAAI,KAAK,uBAAU,CAAC,mBAAmB,EAAE;YACxE,MAAM,IAAI,oBAAW,CAAC,iDAAiD,EAAE,iBAAiB,CAAC,YAAY,CAAC,CAAC;SAC5G;QAED,MAAM,eAAe,GAAG,iBAAiB,CAAC,YAAmC,CAAC;QAC9E,MAAM,IAAI,GAAG,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;QACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC;QAEhF,IAAI,CAAC,QAAQ,EAAE;YACX,MAAM,IAAI,oBAAW,CACjB,8FAA8F,EAC9F,eAAe,CAClB,CAAC;SACL;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,YAAY,EAAE,IAAI,CAAC,IAAI,QAAQ,CAAC;QAC1E,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC;QAE9F,MAAM,MAAM,GAAqB;YAC7B,EAAE,EAAE,QAAQ;YACZ,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,iBAAiB,CAAC,YAAY,CAAC,WAAW;YACvD,OAAO,EAAE,aAAa;YACtB,GAAG,EAAE,IAAI,CAAC,IAAI;YACd,UAAU,EAAE,EAAE;SACjB,CAAC;QAEF,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;QAErD,IAAI,SAAS,EAAE;YACX,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;SACzD;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,iBAAiB,CAAC,SAA0B;QAChD,MAAM,UAAU,GAA+B,EAAE,CAAC;QAElD,KAAK,MAAM,MAAM,IAAI,SAAS,CAAC,OAAO,EAAE;YACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;YAEzB,IAAI,CAAC,IAAI,EAAE;gBACP,MAAM,IAAI,oBAAW,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;aACzD;YAED,IAAI,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE;gBACnB,MAAM,IAAI,oBAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;aACpE;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,IAAI,GAAG,OAAO,EAAE,YAAY,CAAC,IAAI,IAAI,EAAE,CAAC;YAE9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC;YAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,IAAI,UAAU,CAAC;YAChF,MAAM,YAAY,GACd,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,cAAc,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAE7F,UAAU,CAAC,IAAI,CAAC;gBACZ,IAAI,EAAE,UAAU;gBAChB,WAAW,EAAE,YAAY;gBACzB,IAAI,EAAE,YAAY;gBAClB,QAAQ,EAAE,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC;aAC5C,CAAC,CAAC;SACN;QAED,OAAO,UAAU,CAAC;IACtB,CAAC;IAEO,kBAAkB,CAAC,QAAqB;QAC5C,OAAO,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,YAAY,KAAK,QAAQ,CAAC,CAAC;IAC7F,CAAC;IAEO,qBAAqB,CAAC,EAAU,EAAE,QAAqB;QAC3D,yDAAyD;QACzD,IAAI,IAAI,GAAG,MAAM,CAAC;QAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAElD,QAAQ,QAAQ,EAAE,IAAI,EAAE;YACpB,KAAK,uBAAU,CAAC,aAAa;gBACzB,IAAI,GAAG,MAAM,CAAC;gBACd,MAAM;YAEV,KAAK,uBAAU,CAAC,aAAa;gBACzB,IAAI,GAAG,QAAQ,CAAC;gBAChB,MAAM;YAEV,KAAK,uBAAU,CAAC,cAAc;gBAC1B,IAAI,GAAG,SAAS,CAAC;gBACjB,MAAM;YAEV;gBACI,OAAO,CAAC,GAAG,CACP,GAAG,IAAA,uBAAc,EAAC,QAAQ,CAAC,yCAAyC,EAAE,wBAAwB,CACjG,CAAC;gBACF,MAAM;SACb;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;IAEO,iBAAiB,CAAC,QAAqB;QAC3C,IAAI,QAA8B,CAAC;QAEnC,IAAI,QAAQ,CAAC,IAAI,KAAK,uBAAU,CAAC,iBAAiB,EAAE;YAChD,QAAQ,GAAI,QAA8B,CAAC,IAAI,CAAC;SACnD;QAED,IAAI,QAAQ,EAAE,IAAI,KAAK,uBAAU,CAAC,SAAS,EAAE;YACzC,MAAM,SAAS,GAAG,QAAyB,CAAC;YAE5C,6BAA6B;YAC7B,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAChC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,uBAAU,CAAC,gBAAgB,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAU,CAAC,WAAW,CAC9F,CAAC;YAEF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACpB,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;aACvB;iBAAM;gBACH,IAAA,eAAK,EAAC,EAAE,CAAC,CAAC;aACb;SACJ;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAEO,kBAAkB,CAAC,QAAqB;QAC5C,IAAI,QAAQ,CAAC,aAAa,EAAE;YACxB,OAAO,IAAI,CAAC;SACf;QAED,IAAI,QAAQ,CAAC,IAAI,KAAK,uBAAU,CAAC,iBAAiB,EAAE;YAChD,MAAM,QAAQ,GAAI,QAA8B,CAAC,IAAI,CAAC;YAEtD,IAAI,QAAQ,EAAE,IAAI,KAAK,uBAAU,CAAC,SAAS,EAAE;gBACzC,MAAM,SAAS,GAAG,QAAyB,CAAC;gBAE5C,OAAO,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,uBAAU,CAAC,gBAAgB,CAAC,CAAC;aACpF;SACJ;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,YAAY,CAAC,eAAoC;QACrD,MAAM,UAAU,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACjD,IAAI,SAAsC,CAAC;QAE3C,QAAQ,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;YAC5B,KAAK,uBAAU,CAAC,WAAW;gBACvB,SAAS,GAAG,UAAU,CAAC,IAAuB,CAAC;gBAC/C,MAAM;YAEV,KAAK,uBAAU,CAAC,aAAa,CAAC,CAAC;gBAC3B,MAAM,IAAI,GAAI,UAAU,CAAC,IAA0B,CAAC,QAAQ,CAAC;gBAE7D,IAAI,MAAM,IAAI,IAAI,EAAE;oBAChB,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnD;qBAAM;oBACH,MAAM,IAAI,oBAAW,CACjB,iFAAiF,EACjF,UAAU,CAAC,IAAI,CAClB,CAAC;iBACL;gBAED,MAAM;aACT;YAED;gBACI,IAAI,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;oBACxB,MAAM,IAAI,oBAAW,CACjB,8CAA8C,uBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAChF,UAAU,CAAC,IAAI,CAClB,CAAC;iBACL;gBAED,yCAAyC;gBACzC,IAAI,UAAU,EAAE;oBACZ,MAAM,IAAI,oBAAW,CAAC,oCAAoC,EAAE,UAAU,CAAC,CAAC;iBAC3E;gBAED,MAAM;SACb;QAED,OAAO,SAAS,CAAC;IACrB,CAAC;CACJ;AA7OD,kCA6OC"}
+4
dist/manifest/index.d.ts
export * from './descriptors';
export * from './errors';
export * from './fileScanner';
export * from './scanner';
+23
dist/manifest/index.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};
Object.defineProperty(exports, "__esModule", { value: true });
__exportStar(require("./descriptors"), exports);
__exportStar(require("./errors"), exports);
__exportStar(require("./fileScanner"), exports);
__exportStar(require("./scanner"), exports);
//# sourceMappingURL=index.js.map
+1
dist/manifest/index.js.map
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/manifest/index.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;;;;;;;;;;;AAE/C,gDAA8B;AAC9B,2CAAyB;AACzB,gDAA8B;AAC9B,4CAA0B"}
+14
dist/manifest/parser.d.ts
import { Block } from 'comment-parser';
import ts, { SourceFile } from 'typescript';
export interface Comment {
compilerNode: ts.Node;
commentBlock: Block;
}
export type ParsedSource = {
sourceFile: SourceFile;
comments: Comment[];
types: {
[key: string]: ts.TypeLiteralNode;
};
};
export declare function parseFile(program: ts.Program, file: string): ParsedSource | undefined;
+160
dist/manifest/parser.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.parseFile = void 0;
const tsdoc = __importStar(require("@microsoft/tsdoc"));
const comment_parser_1 = require("comment-parser");
const typescript_1 = __importStar(require("typescript"));
const debug_1 = __importDefault(require("./debug"));
/**
* Returns true if the specified SyntaxKind is part of a declaration form.
*
* Based on ts.isDeclarationKind() from the compiler.
* https://github.com/microsoft/TypeScript/blob/v3.0.3/src/compiler/utilities.ts#L6382
*/
function isDeclarationKind(kind) {
return (kind === typescript_1.default.SyntaxKind.ArrowFunction ||
kind === typescript_1.default.SyntaxKind.BindingElement ||
kind === typescript_1.default.SyntaxKind.ClassDeclaration ||
kind === typescript_1.default.SyntaxKind.ClassExpression ||
kind === typescript_1.default.SyntaxKind.Constructor ||
kind === typescript_1.default.SyntaxKind.EnumDeclaration ||
kind === typescript_1.default.SyntaxKind.EnumMember ||
kind === typescript_1.default.SyntaxKind.ExportSpecifier ||
kind === typescript_1.default.SyntaxKind.FunctionDeclaration ||
kind === typescript_1.default.SyntaxKind.FunctionExpression ||
kind === typescript_1.default.SyntaxKind.GetAccessor ||
kind === typescript_1.default.SyntaxKind.ImportClause ||
kind === typescript_1.default.SyntaxKind.ImportEqualsDeclaration ||
kind === typescript_1.default.SyntaxKind.ImportSpecifier ||
kind === typescript_1.default.SyntaxKind.InterfaceDeclaration ||
kind === typescript_1.default.SyntaxKind.JsxAttribute ||
kind === typescript_1.default.SyntaxKind.MethodDeclaration ||
kind === typescript_1.default.SyntaxKind.MethodSignature ||
kind === typescript_1.default.SyntaxKind.ModuleDeclaration ||
kind === typescript_1.default.SyntaxKind.NamespaceExportDeclaration ||
kind === typescript_1.default.SyntaxKind.NamespaceImport ||
kind === typescript_1.default.SyntaxKind.Parameter ||
kind === typescript_1.default.SyntaxKind.PropertyAssignment ||
kind === typescript_1.default.SyntaxKind.PropertyDeclaration ||
kind === typescript_1.default.SyntaxKind.PropertySignature ||
kind === typescript_1.default.SyntaxKind.SetAccessor ||
kind === typescript_1.default.SyntaxKind.ShorthandPropertyAssignment ||
kind === typescript_1.default.SyntaxKind.TypeAliasDeclaration ||
kind === typescript_1.default.SyntaxKind.TypeParameter ||
kind === typescript_1.default.SyntaxKind.VariableDeclaration ||
kind === typescript_1.default.SyntaxKind.JSDocTypedefTag ||
kind === typescript_1.default.SyntaxKind.JSDocCallbackTag ||
kind === typescript_1.default.SyntaxKind.JSDocPropertyTag);
}
/**
* Retrieves the JSDoc-style comments associated with a specific AST node.
*
* Based on ts.getJSDocCommentRanges() from the compiler.
* https://github.com/microsoft/TypeScript/blob/v3.0.3/src/compiler/utilities.ts#L924
*/
function getJSDocCommentRanges(node, text) {
const commentRanges = [];
switch (node.kind) {
case typescript_1.default.SyntaxKind.Parameter:
case typescript_1.default.SyntaxKind.TypeParameter:
case typescript_1.default.SyntaxKind.FunctionExpression:
case typescript_1.default.SyntaxKind.ArrowFunction:
case typescript_1.default.SyntaxKind.ParenthesizedExpression:
commentRanges.push(...(typescript_1.default.getTrailingCommentRanges(text, node.pos) || []));
break;
}
commentRanges.push(...(typescript_1.default.getLeadingCommentRanges(text, node.pos) || []));
// True if the comment starts with '/**' but not if it is '/**/'
return commentRanges.filter((comment) => text.charCodeAt(comment.pos + 1) === 0x2a /* ts.CharacterCodes.asterisk */ &&
text.charCodeAt(comment.pos + 2) === 0x2a /* ts.CharacterCodes.asterisk */ &&
text.charCodeAt(comment.pos + 3) !== 0x2f /* ts.CharacterCodes.slash */);
}
function walkCompilerAst(node, comments, types) {
// The TypeScript AST doesn't store code comments directly. If you want to find *every* comment,
// you would need to rescan the SourceFile tokens similar to how tsutils.forEachComment() works:
// https://github.com/ajafff/tsutils/blob/v3.0.0/util/util.ts#L453
//
// However, for this demo we are modeling a tool that discovers declarations and then analyzes their doc comments,
// so we only care about TSDoc that would conventionally be associated with an interesting AST node.
const buffer = node.getSourceFile().getFullText(); // don't use getText() here!
// Only consider nodes that are part of a declaration form. Without this, we could discover
// the same comment twice (e.g. for a MethodDeclaration and its PublicKeyword).
if (isDeclarationKind(node.kind)) {
if (node.kind === typescript_1.SyntaxKind.TypeAliasDeclaration) {
const typeAlias = node;
if (typeAlias.type.kind === typescript_1.SyntaxKind.TypeLiteral) {
(0, debug_1.default)('discovered type %s', typeAlias.name.text);
types[typeAlias.name.text] = typeAlias.type;
}
else {
(0, debug_1.default)('could not determine definition for type %s from %s', typeAlias.name.text, typescript_1.default.SyntaxKind[typeAlias.type.kind]);
}
}
// Find "/** */" style comments associated with this node.
// Note that this reinvokes the compiler's scanner -- the result is not cached.
const commentRanges = getJSDocCommentRanges(node, buffer);
if (commentRanges.length > 0) {
for (const commentRange of commentRanges) {
const textRange = tsdoc.TextRange.fromStringRange(buffer, commentRange.pos, commentRange.end);
const blocks = (0, comment_parser_1.parse)(textRange.toString());
if (blocks.length) {
comments.push({
compilerNode: node,
commentBlock: blocks[0], // there should only be one block in textRange
});
}
}
}
}
return node.forEachChild((child) => walkCompilerAst(child, comments, types));
}
function parseFile(program, file) {
(0, debug_1.default)('parsing file %s', file);
// This appears to be necessary to initialize some program state. Without
// this the subsequent getSourceFile will fail.
program.getSemanticDiagnostics();
const sourceFile = program.getSourceFile(file);
sourceFile?.getLineAndCharacterOfPosition;
if (!sourceFile) {
(0, debug_1.default)('unable to get source file %s', file);
return undefined;
}
const comments = [];
const types = {};
walkCompilerAst(sourceFile, comments, types);
return {
sourceFile,
comments,
types,
};
}
exports.parseFile = parseFile;
//# sourceMappingURL=parser.js.map
+1
dist/manifest/parser.js.map
{"version":3,"file":"parser.js","sourceRoot":"","sources":["../../src/manifest/parser.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAE/C,wDAA0C;AAC1C,mDAA8D;AAC9D,yDAA8E;AAC9E,oDAA4B;AAkB5B;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,IAAmB;IAC1C,OAAO,CACH,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,aAAa;QACpC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,cAAc;QACrC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,gBAAgB;QACvC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,WAAW;QAClC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,UAAU;QACjC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,mBAAmB;QAC1C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,kBAAkB;QACzC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,WAAW;QAClC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,YAAY;QACnC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,uBAAuB;QAC9C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,oBAAoB;QAC3C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,YAAY;QACnC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,iBAAiB;QACxC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,iBAAiB;QACxC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,0BAA0B;QACjD,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,SAAS;QAChC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,kBAAkB;QACzC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,mBAAmB;QAC1C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,iBAAiB;QACxC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,WAAW;QAClC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,2BAA2B;QAClD,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,oBAAoB;QAC3C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,aAAa;QACpC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,mBAAmB;QAC1C,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,eAAe;QACtC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,gBAAgB;QACvC,IAAI,KAAK,oBAAE,CAAC,UAAU,CAAC,gBAAgB,CAC1C,CAAC;AACN,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAAC,IAAa,EAAE,IAAY;IACtD,MAAM,aAAa,GAAsB,EAAE,CAAC;IAE5C,QAAQ,IAAI,CAAC,IAAI,EAAE;QACf,KAAK,oBAAE,CAAC,UAAU,CAAC,SAAS,CAAC;QAC7B,KAAK,oBAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,oBAAE,CAAC,UAAU,CAAC,kBAAkB,CAAC;QACtC,KAAK,oBAAE,CAAC,UAAU,CAAC,aAAa,CAAC;QACjC,KAAK,oBAAE,CAAC,UAAU,CAAC,uBAAuB;YACtC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAE,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAC3E,MAAM;KACb;IACD,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,oBAAE,CAAC,uBAAuB,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAE1E,gEAAgE;IAChE,OAAO,aAAa,CAAC,MAAM,CACvB,CAAC,OAAO,EAAE,EAAE,CACR,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,gCAAgC;QAC1E,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,gCAAgC;QAC1E,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,6BAA6B,CAC9E,CAAC;AACN,CAAC;AAED,SAAS,eAAe,CAAC,IAAa,EAAE,QAAmB,EAAE,KAA4B;IACrF,iGAAiG;IACjG,gGAAgG;IAChG,kEAAkE;IAClE,EAAE;IACF,kHAAkH;IAClH,oGAAoG;IAEpG,MAAM,MAAM,GAAW,IAAI,CAAC,aAAa,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC,4BAA4B;IAEvF,4FAA4F;IAC5F,+EAA+E;IAC/E,IAAI,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QAC9B,IAAI,IAAI,CAAC,IAAI,KAAK,uBAAU,CAAC,oBAAoB,EAAE;YAC/C,MAAM,SAAS,GAAG,IAA4B,CAAC;YAE/C,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,KAAK,uBAAU,CAAC,WAAW,EAAE;gBAChD,IAAA,eAAK,EAAC,oBAAoB,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAEjD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAA0B,CAAC;aACrE;iBAAM;gBACH,IAAA,eAAK,EACD,oDAAoD,EACpD,SAAS,CAAC,IAAI,CAAC,IAAI,EACnB,oBAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CACrC,CAAC;aACL;SACJ;QAED,0DAA0D;QAC1D,+EAA+E;QAC/E,MAAM,aAAa,GAAsB,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAE7E,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;gBACtC,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC9F,MAAM,MAAM,GAAG,IAAA,sBAAY,EAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAElD,IAAI,MAAM,CAAC,MAAM,EAAE;oBACf,QAAQ,CAAC,IAAI,CAAC;wBACV,YAAY,EAAE,IAAI;wBAClB,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,8CAA8C;qBAC1E,CAAC,CAAC;iBACN;aACJ;SACJ;KACJ;IAED,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,SAAgB,SAAS,CAAC,OAAmB,EAAE,IAAY;IACvD,IAAA,eAAK,EAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAE/B,0EAA0E;IAC1E,+CAA+C;IAC/C,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAEjC,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC/C,UAAU,EAAE,6BAA6B,CAAC;IAE1C,IAAI,CAAC,UAAU,EAAE;QACb,IAAA,eAAK,EAAC,8BAA8B,EAAE,IAAI,CAAC,CAAC;QAE5C,OAAO,SAAS,CAAC;KACpB;IAED,MAAM,QAAQ,GAAc,EAAE,CAAC;IAC/B,MAAM,KAAK,GAA0B,EAAE,CAAC;IAExC,eAAe,CAAC,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;IAE7C,OAAO;QACH,UAAU;QACV,QAAQ;QACR,KAAK;KACR,CAAC;AACN,CAAC;AA1BD,8BA0BC"}
+13
dist/manifest/scanner.d.ts
/// <reference types="lodash" />
import { WidgetDescriptor } from './descriptors';
export type ScannerOptions = {
defaultVersion?: string;
};
export declare class Scanner {
private sourceRoot;
private options?;
constructor(sourceRoot: string, options?: ScannerOptions | undefined);
scan(): Promise<{
widgets: import("lodash").Dictionary<WidgetDescriptor>;
}>;
}
+35
dist/manifest/scanner.js
"use strict";
// Copyright (c) 2023 System Automation Corporation.
// This file is licensed under the MIT License.
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Scanner = void 0;
const glob_1 = require("glob");
const lodash_1 = require("lodash");
const typescript_1 = __importDefault(require("typescript"));
const fileScanner_1 = require("./fileScanner");
class Scanner {
constructor(sourceRoot, options) {
this.sourceRoot = sourceRoot;
this.options = options;
}
async scan() {
const files = await (0, glob_1.glob)(`${this.sourceRoot}/**/*.{ts,tsx}`);
const widgets = [];
const program = typescript_1.default.createProgram(files, {});
for (const file of files) {
const fileScanner = new fileScanner_1.FileScanner(program, file, this.options);
const widget = fileScanner.scanForWidget();
if (widget) {
widgets.push(widget);
}
}
return {
widgets: (0, lodash_1.keyBy)(widgets, (widget) => widget.id),
};
}
}
exports.Scanner = Scanner;
//# sourceMappingURL=scanner.js.map
+1
dist/manifest/scanner.js.map
{"version":3,"file":"scanner.js","sourceRoot":"","sources":["../../src/manifest/scanner.ts"],"names":[],"mappings":";AAAA,oDAAoD;AACpD,+CAA+C;;;;;;AAE/C,+BAA4B;AAC5B,mCAA+B;AAC/B,4DAA4B;AAE5B,+CAA4C;AAM5C,MAAa,OAAO;IAChB,YAAoB,UAAkB,EAAU,OAAwB;QAApD,eAAU,GAAV,UAAU,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAiB;IAAG,CAAC;IAE5E,KAAK,CAAC,IAAI;QACN,MAAM,KAAK,GAAG,MAAM,IAAA,WAAI,EAAC,GAAG,IAAI,CAAC,UAAU,gBAAgB,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAuB,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,oBAAE,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAE5C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;YACjE,MAAM,MAAM,GAAG,WAAW,CAAC,aAAa,EAAE,CAAC;YAE3C,IAAI,MAAM,EAAE;gBACR,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aACxB;SACJ;QAED,OAAO;YACH,OAAO,EAAE,IAAA,cAAK,EAAC,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;SACjD,CAAC;IACN,CAAC;CACJ;AArBD,0BAqBC"}
+20
-10
bin/generate-manifest.js

@@ -10,4 +10,8 @@ #!/usr/bin/env node

const packageJson = require(path.resolve(process.cwd(), './package.json'));
const { Scanner } = require('../dist');
(async () => {
const scanner = new Scanner('src', { defaultVersion: packageJson.version });
const widgets = (await scanner.scan()).widgets;
const fs = require('fs');

@@ -18,19 +22,25 @@

const getWidgetProperties = async (widgetsList) => {
const temp = [];
console.log('');
for await (const widget of widgetsList) {
for (const widget of widgetsList) {
try {
const widget_folder_path = path.join(folderName, widget);
const WidgetProperties = require(`${widget_folder_path}/WidgetProperties.json`);
if (!WidgetProperties.id) {
console.error(`Missing widget id in ${widget_folder_path}/WidgetProperties.json`);
continue;
}
WidgetProperties.src = 'src/widgets/' + widget;
temp.push(WidgetProperties);
widgets[WidgetProperties.id] = WidgetProperties;
console.info(WidgetProperties.name + ' widget -- READ');
} catch (e) {
if (e.code === 'ERR_MODULE_NOT_FOUND')
console.error(widget + ' widget -- WidgetProperties not defined.');
else console.error('ERROR while reading properties for ' + widget + ':: ', e);
continue;
if (e.code !== 'MODULE_NOT_FOUND') {
console.error('ERROR while reading properties for ' + widget + ':: ', e);
}
}
}
return temp;
};

@@ -42,3 +52,3 @@

widgetsList = fs.readdirSync(folderName).map((widget) => widget);
let WidgetProperties = await getWidgetProperties(widgetsList);
await getWidgetProperties(widgetsList);
console.log('');

@@ -48,3 +58,3 @@ const outputJSON = {

description: '',
widgets: WidgetProperties,
widgets: Object.values(widgets),
};

@@ -51,0 +61,0 @@ if (!fs.existsSync('./dist')) {

+19
-3
package.json
{
"name": "@evoke-platform/plugin-scripts",
"version": "1.0.0-dev.21",
"version": "1.0.0-dev.22",
"description": "Scripts for managing an Evoke platform plugin project",

@@ -25,2 +25,5 @@ "homepage": "https://github.com/Evoke-Platform/evoke-sdk/blob/main/packages/plugin-scripts/README.md",

"scripts": {
"build": "tsc",
"pretest": "npm run build",
"test": "mocha \"dist/__tests__/**/*.unit.js\"",
"release": "commit-and-tag-version -t plugin-scripts@ --releaseCommitMessageFormat \"chore(release): plugin-scripts@{{currentTag}} [skip ci]\"",

@@ -33,8 +36,21 @@ "predeploy": "cp ../../LICENSE .",

"dependencies": {
"@microsoft/tsdoc": "^0.14.2",
"comment-parser": "^1.3.1",
"glob": "^10.2.1",
"jszip": "^3.10.0",
"mkdirp": "^3.0.0"
"lodash": "^4.17.21",
"mkdirp": "^3.0.0",
"typescript": "^5.0.4"
},
"devDependencies": {
"commit-and-tag-version": "^11.2.1"
"@types/chai": "^4.3.4",
"@types/chai-as-promised": "^7.1.5",
"@types/dirty-chai": "^2.0.2",
"@types/lodash": "^4.14.194",
"chai": "^4.3.7",
"chai-as-promised": "^7.1.1",
"commit-and-tag-version": "^11.2.1",
"dirty-chai": "^2.0.1",
"mocha": "^10.2.0"
}
}