sammi-next 1.5.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -4
- package/dist/node/cli.mjs +1 -1
- package/dist/runtime/index.d.ts +6 -1
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +2 -19
- package/dist/runtime/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,20 +2,23 @@
|
|
|
2
2
|
|
|
3
3
|
> Modern builder and runtime for SAMMI Extensions
|
|
4
4
|
|
|
5
|
-
## Features
|
|
5
|
+
## Features
|
|
6
6
|
- Extension Preview
|
|
7
7
|
- Helper functions
|
|
8
8
|
- Rich Features
|
|
9
9
|
- Optimize Build
|
|
10
10
|
- Fully Typed APIs
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
- A
|
|
12
|
+
## Description
|
|
13
|
+
SAMMI Next is a [SAMMI] Bridge extensions build tool inspired on [Vite] that significantly improves the extension development experience. It consists of two major parts:
|
|
14
|
+
- A runtime API with helper functions to develop a [SAMMI] extension with the SAMMI Next format.
|
|
15
|
+
- A cli that bundles your code with [tsdown], pre-configured to output highly optimized code for production.
|
|
15
16
|
|
|
16
17
|
## Import Globals
|
|
17
18
|
```TypeScript
|
|
18
19
|
/// <reference types="sammi-next" />
|
|
19
20
|
```
|
|
20
21
|
|
|
22
|
+
[SAMMI]: https://sammi.solutions/
|
|
23
|
+
[Vite]: https://vite.dev/
|
|
21
24
|
[tsdown]: https://tsdown.dev/
|
package/dist/node/cli.mjs
CHANGED
package/dist/runtime/index.d.ts
CHANGED
|
@@ -52,7 +52,12 @@ interface initExtensionOptions {
|
|
|
52
52
|
* @param options Whether to skip the process of proxying your extension (allowing other scripts to modify your exports).
|
|
53
53
|
* @returns Parsed and cleaned config.
|
|
54
54
|
*/
|
|
55
|
-
declare function initExtension(config: Record<string, any>, options
|
|
55
|
+
declare function initExtension(config: Record<string, any>, options: Omit<initExtensionOptions, 'skipProxying'> & {
|
|
56
|
+
skipProxying: true;
|
|
57
|
+
}): ExtensionConfig;
|
|
58
|
+
declare function initExtension(config: Record<string, any>, options?: Omit<initExtensionOptions, 'skipProxying'> & {
|
|
59
|
+
skipProxying: false;
|
|
60
|
+
}): Readonly<ExtensionConfig>;
|
|
56
61
|
/**
|
|
57
62
|
* Retrieves an [insert_external] section by its extension id.
|
|
58
63
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/runtime/types.ts","../../src/runtime/index.ts"],"mappings":";;;;QAAQ,MAAA;EAAA,IACA,eAAA,EAAiB,MAAA,SAAe,kBAAA;AAAA;;;;UAMvB,eAAA;EAPT;EASJ,IAAA;EARoC;EAUpC,EAAA;EAVmE;EAYnE,IAAA;EAZmE;EAcnE,OAAA;AAAA;;;;UAMa,kBAAA;EAAA,SACJ,OAAA;EAAA,SACA,OAAA,GAAU,eAAA;EAAA,UACT,GAAA;AAAA;;;UClBJ,oBAAA;;;;;;;;EAQN,YAAA;AAAA;;;;ADPJ;;;;;;;;;;AAcA;iBCYgB,aAAA,CAEZ,MAAA,EAAQ,MAAA,eACR,OAAA,
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/runtime/types.ts","../../src/runtime/index.ts"],"mappings":";;;;QAAQ,MAAA;EAAA,IACA,eAAA,EAAiB,MAAA,SAAe,kBAAA;AAAA;;;;UAMvB,eAAA;EAPT;EASJ,IAAA;EARoC;EAUpC,EAAA;EAVmE;EAYnE,IAAA;EAZmE;EAcnE,OAAA;AAAA;;;;UAMa,kBAAA;EAAA,SACJ,OAAA;EAAA,SACA,OAAA,GAAU,eAAA;EAAA,UACT,GAAA;AAAA;;;UClBJ,oBAAA;;;;;;;;EAQN,YAAA;AAAA;;;;ADPJ;;;;;;;;;;AAcA;iBCYgB,aAAA,CAEZ,MAAA,EAAQ,MAAA,eACR,OAAA,EAAS,IAAA,CAAK,oBAAA;EACV,YAAA;AAAA,IAEL,eAAA;AAAA,iBACa,aAAA,CAEZ,MAAA,EAAQ,MAAA,eACR,OAAA,GAAU,IAAA,CAAK,oBAAA;EACX,YAAA;AAAA,IAEL,QAAA,CAAS,eAAA;;;;;;;AA7CuD;;;;;AAgCnE;;iBAyEgB,kBAAA,CAAmB,YAAA,WAAuB,cAAA;AAAA,UAIhD,2BAAA;EA1EQ;;;;;;;EAkFd,kBAAA;EAlFc;;;;;;EAyFd,sBAAA;AAAA;;;;;;;;;;;;;;;;;;;AAnBJ;;;;;AAEC;;;;;AA4DD;;;;;;;;;iBAAgB,oBAAA,CACZ,QAAA,cACA,OAAA,GAAU,2BAAA"}
|
package/dist/runtime/index.js
CHANGED
|
@@ -3,21 +3,7 @@
|
|
|
3
3
|
window.SAMMIExtensions ??= {};
|
|
4
4
|
const PROXY_PREFIX = "[SAMMI-NEXT-PROXY]";
|
|
5
5
|
const defaultInitExtensionOptions = { skipProxying: false };
|
|
6
|
-
|
|
7
|
-
* Removes unnecessary data from a raw extension config object and parses it into an ExtensionConfig.
|
|
8
|
-
*
|
|
9
|
-
* Exports the config through the `SAMMIExtensions` namespace with the `_config` key.
|
|
10
|
-
*
|
|
11
|
-
* Generates a Proxy of the extension object to avoid other scripts trying to overwrite it.
|
|
12
|
-
*
|
|
13
|
-
* @example
|
|
14
|
-
* const extension_config = SAMMIExtensions['extension-id']._config;
|
|
15
|
-
*
|
|
16
|
-
* @param config Unparsed config object.
|
|
17
|
-
* @param options Whether to skip the process of proxying your extension (allowing other scripts to modify your exports).
|
|
18
|
-
* @returns Parsed and cleaned config.
|
|
19
|
-
*/
|
|
20
|
-
function initExtension(config, options = { skipProxying: false }) {
|
|
6
|
+
function initExtension(config, options) {
|
|
21
7
|
let response = {
|
|
22
8
|
id: config.id,
|
|
23
9
|
name: config.name,
|
|
@@ -108,10 +94,7 @@ const defaultInsertCommandSectionOptions = {
|
|
|
108
94
|
* @param options The initialization options.
|
|
109
95
|
* @returns wrapped export default callback
|
|
110
96
|
*/
|
|
111
|
-
function insertCommandSection(callback, options
|
|
112
|
-
waitForSammiclient: true,
|
|
113
|
-
waitForSAMMIExtensions: false
|
|
114
|
-
}) {
|
|
97
|
+
function insertCommandSection(callback, options) {
|
|
115
98
|
const settings = Object.assign(defaultInsertCommandSectionOptions, options);
|
|
116
99
|
const wrapper = () => {
|
|
117
100
|
if (!sammiclient && settings.waitForSammiclient) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","names":[],"sources":["../../src/runtime/index.ts"],"sourcesContent":["/// <reference types=\"sammi-bridge-types\" />\nimport type { ExtensionConfig, SAMMINextExtension } from \"./types\";\n\nwindow.SAMMIExtensions ??= {};\nconst PROXY_PREFIX = \"[SAMMI-NEXT-PROXY]\";\n\ninterface initExtensionOptions {\n /**\n * Whether to skip the process of proxying your extension.\n *\n * Warning: this allows other scripts to modify your exports.\n *\n * @default false\n */\n skipProxying?: boolean\n}\nconst defaultInitExtensionOptions: initExtensionOptions = {\n skipProxying: false,\n}\n/**\n * Removes unnecessary data from a raw extension config object and parses it into an ExtensionConfig.\n *\n * Exports the config through the `SAMMIExtensions` namespace with the `_config` key.\n *\n * Generates a Proxy of the extension object to avoid other scripts trying to overwrite it.\n *\n * @example\n * const extension_config = SAMMIExtensions['extension-id']._config;\n *\n * @param config Unparsed config object.\n * @param options Whether to skip the process of proxying your extension (allowing other scripts to modify your exports).\n * @returns Parsed and cleaned config.\n */\nexport function initExtension(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n config: Record<string, any>,\n options: initExtensionOptions
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../../src/runtime/index.ts"],"sourcesContent":["/// <reference types=\"sammi-bridge-types\" />\nimport type { ExtensionConfig, SAMMINextExtension } from \"./types\";\n\nwindow.SAMMIExtensions ??= {};\nconst PROXY_PREFIX = \"[SAMMI-NEXT-PROXY]\";\n\ninterface initExtensionOptions {\n /**\n * Whether to skip the process of proxying your extension.\n *\n * Warning: this allows other scripts to modify your exports.\n *\n * @default false\n */\n skipProxying?: boolean\n}\nconst defaultInitExtensionOptions: initExtensionOptions = {\n skipProxying: false,\n}\n/**\n * Removes unnecessary data from a raw extension config object and parses it into an ExtensionConfig.\n *\n * Exports the config through the `SAMMIExtensions` namespace with the `_config` key.\n *\n * Generates a Proxy of the extension object to avoid other scripts trying to overwrite it.\n *\n * @example\n * const extension_config = SAMMIExtensions['extension-id']._config;\n *\n * @param config Unparsed config object.\n * @param options Whether to skip the process of proxying your extension (allowing other scripts to modify your exports).\n * @returns Parsed and cleaned config.\n */\nexport function initExtension(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n config: Record<string, any>,\n options: Omit<initExtensionOptions, 'skipProxying'> & {\n skipProxying: true\n },\n): ExtensionConfig\nexport function initExtension(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n config: Record<string, any>,\n options?: Omit<initExtensionOptions, 'skipProxying'> & {\n skipProxying: false\n },\n): Readonly<ExtensionConfig>\nexport function initExtension(\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\n config: Record<string, any>,\n options?: initExtensionOptions\n): Readonly<ExtensionConfig> | ExtensionConfig {\n let response: ExtensionConfig = {\n id: config.id as string,\n name: config.name as string,\n version: config.version as string,\n info: config.info as string | undefined,\n };\n\n window.SAMMIExtensions = window.SAMMIExtensions || {};\n SAMMIExtensions[response.id] = SAMMIExtensions[response.id] || {};\n if (SAMMIExtensions[response.id]?._config)\n throw new Error('The extension with the provided id was already initialized');\n\n const settings = Object.assign(defaultInitExtensionOptions, options);\n if (!settings.skipProxying)\n response = Object.freeze(response);\n\n // @ts-expect-error This is before proxying the extension, so no error.\n SAMMIExtensions[response.id]!._config ??= response;\n if (settings.skipProxying) return response;\n\n SAMMIExtensions[response.id] = new Proxy(SAMMIExtensions[response.id]!, {\n set(target, prop) {\n console.error(PROXY_PREFIX, \": Blocked setting value of:\", prop, \"on:\", target._config?.id);\n return true;\n },\n defineProperty(target, property) {\n console.error(PROXY_PREFIX, \": Blocked property redefinition of:\", property, \"on:\", target._config?.id);\n return true;\n },\n deleteProperty(target, p) {\n console.error(PROXY_PREFIX, \": Blocked deletion of:\", p, \"on:\", target._config?.id);\n return true;\n },\n setPrototypeOf(target) {\n console.error(PROXY_PREFIX, \": Blocked changing prototype of:\", target._config?.id);\n return true;\n },\n });\n return response;\n}\n\n/**\n * Retrieves an [insert_external] section by its extension id.\n *\n * ### Original documentation from https://sammi.solutions/extensions/build\n * This section appears inside the extension’s tab in Bridge, and it provides a visual interface for the extension if needed. It’s written in HTML and CSS.\n *\n * @example\n * const EXTERNAL = getExternalSection(config.id);\n * EXTERNAL.querySelector(\"button\")?.addEventListener('click', () => console.log('Hello world!'));\n *\n * @param extension_id The id of the SAMMI Next extension to retrieve its [insert_external] section.\n * @returns the div element that wraps your extension.\n */\nexport function getExternalSection(extension_id: string): HTMLDivElement {\n return document.getElementById(`${extension_id}-external`) as HTMLDivElement;\n}\n\ninterface insertCommandSectionOptions {\n /**\n * Whether to wait for `sammiclient` to exist.\n * This is enabled by default because every extension that uses `SAMMI` depends on `sammiclient`.\n * You can disable it if your [insert_command] section doesn't use neither `SAMMI` nor `sammiclient`.\n *\n * @default true\n */\n waitForSammiclient?: boolean;\n /**\n * Whether to wait for `SAMMIExtensions` to exist.\n * You must set this to `true` if you use the `SAMMIExtensions` namespace inside your [insert_command] section.\n *\n * @default false\n */\n waitForSAMMIExtensions?: boolean;\n}\nconst defaultInsertCommandSectionOptions: insertCommandSectionOptions = {\n waitForSammiclient: true,\n waitForSAMMIExtensions: false,\n}\n/**\n * Generates your [insert_command] section.\n * This should be used in the default export of your extension.\n *\n * By default, it wraps your callback to wait for `sammiclient` and `SAMMI` are initialized.\n * Its behavior can be changed in the options param.\n *\n * ### Original documentation from https://sammi.solutions/extensions/build\n * In this section, you can define Extension Commands.\n * These commands will be available to users in SAMMI Core when they install your extension.\n * You can define multiple commands in this section.\n * Refer to the SAMMI Bridge documentation for Extension Command details.\n * In this section, you can also automatically call your main extension function that should run as soon as SAMMI connects to Bridge.\n *\n * @example\n * export default insertCommandSection(() => {\n * SAMMI.extCommand(\"Extension Sample Command\", 3355443, 52).catch(e => console.error(e));\n * sammiclient.on(\"Extension Sample Command\", () => {\n * const handler = async () => {\n * await SAMMI.notification('Command Sample');\n * };\n * handler().catch((e) => console.error(e));\n * });\n * });\n * export default insertCommandSection(\n * () => console.log(\"Hello world\"),\n * { waitForSammiclient: false }\n * );\n * export default insertCommandSection(\n * () => console.log(SAMMIExtensions[\"extension-id\"]),\n * { waitForSAMMIExtensions: true }\n * );\n *\n * @param callback A callback with the logic that you will insert in your [insert_command] section.\n * @param options The initialization options.\n * @returns wrapped export default callback\n */\nexport function insertCommandSection(\n callback: () => void,\n options?: insertCommandSectionOptions,\n): () => void {\n const settings = Object.assign(defaultInsertCommandSectionOptions, options);\n\n const wrapper = () => {\n if (!sammiclient && settings.waitForSammiclient) {\n setTimeout(wrapper, 0);\n return;\n }\n\n if (!SAMMIExtensions && settings.waitForSAMMIExtensions) {\n setTimeout(wrapper, 0);\n return;\n }\n\n callback();\n };\n\n return wrapper;\n}\n\nexport type { ExtensionConfig as FullExtensionConfig } from '@shared/config-types';\nexport type { ExtensionConfig, SAMMINextExtension };\n"],"mappings":";;AAGA,OAAO,oBAAoB,EAAE;AAC7B,MAAM,eAAe;AAYrB,MAAM,8BAAoD,EACtD,cAAc,OACjB;AA6BD,SAAgB,cAEZ,QACA,SAC2C;CAC3C,IAAI,WAA4B;EAC5B,IAAI,OAAO;EACX,MAAM,OAAO;EACb,SAAS,OAAO;EAChB,MAAM,OAAO;EAChB;AAED,QAAO,kBAAkB,OAAO,mBAAmB,EAAE;AACrD,iBAAgB,SAAS,MAAM,gBAAgB,SAAS,OAAO,EAAE;AACjE,KAAI,gBAAgB,SAAS,KAAK,QAC9B,OAAM,IAAI,MAAM,6DAA6D;CAEjF,MAAM,WAAW,OAAO,OAAO,6BAA6B,QAAQ;AACpE,KAAI,CAAC,SAAS,aACV,YAAW,OAAO,OAAO,SAAS;AAGtC,iBAAgB,SAAS,IAAK,YAAY;AAC1C,KAAI,SAAS,aAAc,QAAO;AAElC,iBAAgB,SAAS,MAAM,IAAI,MAAM,gBAAgB,SAAS,KAAM;EACpE,IAAI,QAAQ,MAAM;AACd,WAAQ,MAAM,cAAc,+BAA+B,MAAM,OAAO,OAAO,SAAS,GAAG;AAC3F,UAAO;;EAEX,eAAe,QAAQ,UAAU;AAC7B,WAAQ,MAAM,cAAc,uCAAuC,UAAU,OAAO,OAAO,SAAS,GAAG;AACvG,UAAO;;EAEX,eAAe,QAAQ,GAAG;AACtB,WAAQ,MAAM,cAAc,0BAA0B,GAAG,OAAO,OAAO,SAAS,GAAG;AACnF,UAAO;;EAEX,eAAe,QAAQ;AACnB,WAAQ,MAAM,cAAc,oCAAoC,OAAO,SAAS,GAAG;AACnF,UAAO;;EAEd,CAAC;AACF,QAAO;;;;;;;;;;;;;;;AAgBX,SAAgB,mBAAmB,cAAsC;AACrE,QAAO,SAAS,eAAe,GAAG,aAAa,WAAW;;AAoB9D,MAAM,qCAAkE;CACpE,oBAAoB;CACpB,wBAAwB;CAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsCD,SAAgB,qBACZ,UACA,SACU;CACV,MAAM,WAAW,OAAO,OAAO,oCAAoC,QAAQ;CAE3E,MAAM,gBAAgB;AAClB,MAAI,CAAC,eAAe,SAAS,oBAAoB;AAC7C,cAAW,SAAS,EAAE;AACtB;;AAGJ,MAAI,CAAC,mBAAmB,SAAS,wBAAwB;AACrD,cAAW,SAAS,EAAE;AACtB;;AAGJ,YAAU;;AAGd,QAAO"}
|