@tpluscode/rdf-ns-builders 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 4.3.0
+
+### Minor Changes
+
+- ff6f87c: Add a way to extend namespace factory
+
 ## 4.2.0
 
 ### Minor Changes

package/Factory.d.ts

@@ -1,6 +1,7 @@
 import * as StrictBuilders from './index.js';
+import type { CustomNamespaces } from './index.js';
 export interface NsBuildersFactory {
-    ns: typeof StrictBuilders;
+    ns: typeof StrictBuilders & CustomNamespaces;
 }
 export declare class NsBuildersFactory {
     init(): void;

package/Factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Factory.d.ts","sourceRoot":"","sources":["Factory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,cAAc,MAAM,YAAY,CAAA;AAE5C,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,OAAO,cAAc,CAAA;CAC1B;AAED,qBAAa,iBAAiB;IAC5B,IAAI;CAGL"}
+{"version":3,"file":"Factory.d.ts","sourceRoot":"","sources":["Factory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,cAAc,MAAM,YAAY,CAAA;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAElD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,OAAO,cAAc,GAAG,gBAAgB,CAAA;CAC7C;AAED,qBAAa,iBAAiB;IAC5B,IAAI;CAGL"}

package/README.md

@@ -74,3 +74,41 @@ This will create a directory `source`, containing typescript modules for all voc
 
 [rdfv]: https://github.com/zazuko/rdf-vocabularies
 [ns]: http://npm.im/@rdfjs/namespace
+
+## Adding your own vocabularies
+
+To extend the interface of `env.ns` you need to add you own factory which will add additional
+namespace builders to the environment. TypeScript users will also need to extend the `CustomPrefixes`
+interface.
+
+```ts
+// ./ns.ts
+import { NamespaceBuilder } from '@rdfjs/namespace'
+
+type ExampleTerms = 'foo' | 'bar
+
+declare module '@tpluscode/rdf-ns-builders' {
+  interface CustomNamespaces {
+    ex: NamespaceBuilder<ExampleTerms>
+  }
+}
+
+export class ExampleNsFactory {
+  init(this: Environment<NsBuildersFactory | NamespaceFactory>) {
+    this.ns = {
+      ...this.ns,
+      ex: this.namespace<ExampleTerms>('https://example.com/'),
+    }
+  }
+}
+```
+
+Then, use it to create an extended environment.
+
+```ts
+// ./env.ts
+import { create } from '@zazuko/env'
+import { ExampleNsFactory } from './ns.js'
+
+export default create(TalosNsFactory)
+```

package/index.d.ts

@@ -1,4 +1,6 @@
 import { NsBuildersFactory } from './Factory.js';
+export interface CustomNamespaces {
+}
 export default NsBuildersFactory;
 export * from './strict.js';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,eAAe,iBAAiB,CAAA;AAChC,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,WAAW,gBAAgB;CAAG;AAEpC,eAAe,iBAAiB,CAAA;AAChC,cAAc,aAAa,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tpluscode/rdf-ns-builders",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Generated RDF/JS namespace builders for common vocabularies",
   "type": "module",
   "main": "index.js",