@occultist/occultist 0.0.10 → 0.0.11

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/dist/types.d.ts CHANGED
@@ -8,14 +8,30 @@ export interface StaticContext {
8
8
  link(alias: string, as: string): string;
9
9
  }
10
10
  export interface Extension {
11
+ /**
12
+ * The name of the extension.
13
+ */
11
14
  name: string;
15
+ /**
16
+ * Setup method which can perform async setup tasks
17
+ * and report status via a readable stream.
18
+ */
12
19
  setup?(): ReadableStream;
13
- getAsset?(): StaticAsset | undefined;
20
+ /**
21
+ * Retrieves a static assets from the extension.
22
+ *
23
+ * @param assetAlias The alias for the asset.
24
+ */
25
+ getAsset?(assetAlias: string): StaticAsset | undefined;
26
+ /**
27
+ * Root level aliases the extension uses to identify
28
+ * the assets it manages.
29
+ */
14
30
  staticAliases?: string[];
15
31
  }
16
32
  export interface StaticExtension {
17
33
  /**
18
- * The name of the static extension.
34
+ * The name of the extension.
19
35
  */
20
36
  name: string;
21
37
  /**
package/lib/types.ts CHANGED
@@ -11,16 +11,37 @@ export interface StaticContext {
11
11
  }
12
12
 
13
13
  export interface Extension {
14
+
15
+ /**
16
+ * The name of the extension.
17
+ */
14
18
  name: string;
19
+
20
+ /**
21
+ * Setup method which can perform async setup tasks
22
+ * and report status via a readable stream.
23
+ */
15
24
  setup?(): ReadableStream;
16
- getAsset?(): StaticAsset | undefined;
25
+
26
+ /**
27
+ * Retrieves a static assets from the extension.
28
+ *
29
+ * @param assetAlias The alias for the asset.
30
+ */
31
+ getAsset?(assetAlias: string): StaticAsset | undefined;
32
+
33
+ /**
34
+ * Root level aliases the extension uses to identify
35
+ * the assets it manages.
36
+ */
17
37
  staticAliases?: string[];
38
+
18
39
  };
19
40
 
20
41
  export interface StaticExtension {
21
42
 
22
43
  /**
23
- * The name of the static extension.
44
+ * The name of the extension.
24
45
  */
25
46
  name: string;
26
47
 
package/package.json CHANGED
@@ -35,7 +35,7 @@
35
35
  "jsonld": "^9.0.0",
36
36
  "typescript": "^5.9.3"
37
37
  },
38
- "version": "0.0.10",
38
+ "version": "0.0.11",
39
39
  "scripts": {
40
40
  "build": "tsc -p tsconfig.build.json",
41
41
  "test": "node --test"