Add initial @nx.js/ns package (#172)

Author: TooTallNate

.changeset/blue-sheep-report.md

@@ -0,0 +1,5 @@
+---
+"@nx.js/install-title": patch
+---
+
+Use `@nx.js/ns` package

.changeset/heavy-beers-beam.md

@@ -0,0 +1,5 @@
+---
+"@nx.js/ns": major
+---
+
+Add initial `@nx.js/ns` package

packages/install-title/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@nx.js/constants": "^0.4.0",
     "@nx.js/ncm": "^1.2.0",
+    "@nx.js/ns": "^0.0.0",
     "@nx.js/util": "^1.1.0",
     "@tootallnate/nsp": "^0.0.2"
   },

packages/install-title/src/index.ts

@@ -16,14 +16,14 @@ import {
 	NcmPackagedContentInfo,
 	NcmApplicationMetaExtendedHeader,
 } from '@nx.js/ncm';
-import { parseNsp, type FileEntry } from '@tootallnate/nsp';
 import {
 	NsApplicationRecordType,
 	nsDeleteApplicationRecord,
 	nsInvalidateApplicationControlCache,
 	nsListApplicationRecordContentMeta,
 	nsPushApplicationRecord,
-} from './ipc/ns';
+} from '@nx.js/ns';
+import { parseNsp, type FileEntry } from '@tootallnate/nsp';
 import { esImportTicket } from './ipc/es';
 import { PackagedContentMetaHeader } from './types';
 
@@ -140,7 +140,7 @@ class ContentStoragePlaceholderWriteStream extends WritableStream<Uint8Array> {
 		const placeholderId = contentStorage.generatePlaceHolderId();
 		try {
 			contentStorage.deletePlaceHolder(placeholderId);
-		} catch {}
+		} catch { }
 		contentStorage.createPlaceHolder(contentId, placeholderId, BigInt(size));
 
 		super({
@@ -153,7 +153,7 @@ class ContentStoragePlaceholderWriteStream extends WritableStream<Uint8Array> {
 				console.debug(`Finished writing ${this.#offset} bytes`);
 				try {
 					contentStorage.delete(contentId);
-				} catch {}
+				} catch { }
 				contentStorage.register(contentId, placeholderId);
 			},
 		});
@@ -304,9 +304,9 @@ async function installContentMetaRecords(
 
 	const contentMetaData = new Uint8Array(
 		NcmContentMetaHeader.sizeof +
-			extendedHeaderSize +
-			contentInfos.length * NcmContentInfo.sizeof +
-			extendedDataSize,
+		extendedHeaderSize +
+		contentInfos.length * NcmContentInfo.sizeof +
+		extendedDataSize,
 	);
 
 	// write header
@@ -357,13 +357,13 @@ async function installContentMetaRecords(
 			new Uint8Array(
 				cnmtData,
 				PackagedContentMetaHeader.sizeof +
-					extendedHeaderSize +
-					contentInfos.length * NcmContentInfo.sizeof,
+				extendedHeaderSize +
+				contentInfos.length * NcmContentInfo.sizeof,
 				extendedDataSize,
 			),
 			NcmContentMetaHeader.sizeof +
-				extendedHeaderSize +
-				contentInfos.length * NcmContentInfo.sizeof,
+			extendedHeaderSize +
+			contentInfos.length * NcmContentInfo.sizeof,
 		);
 	}
 
@@ -426,7 +426,7 @@ async function pushApplicationRecord(
 
 	try {
 		nsDeleteApplicationRecord(titleId);
-	} catch {}
+	} catch { }
 
 	nsPushApplicationRecord(
 		titleId,

packages/ns/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@nx.js/ns",
+  "version": "0.0.0",
+  "description": "`ns` service IPC wrapper for nx.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TooTallNate/nx.js.git",
+    "directory": "packages/ns"
+  },
+  "homepage": "https://nxjs.n8.io/ns",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc",
+    "docs": "typedoc && ../../type-aliases-meta.sh"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nx.js/constants": "^0.4.0"
+  },
+  "devDependencies": {
+    "@nx.js/runtime": "workspace:*"
+  },
+  "keywords": [
+    "nx.js",
+    "switch",
+    "ns"
+  ],
+  "author": "Nathan Rajlich <[email protected]>",
+  "license": "MIT"
+}

packages/install-title/src/ipc/ns.ts renamed to packages/ns/src/index.ts

@@ -1,15 +1,8 @@
 // Ported from `tinwoo/nx/ipc/ns_ext.c`
 import { SfBufferAttr } from '@nx.js/constants';
-import { NcmStorageId } from '@nx.js/ncm';
+import { NsApplicationRecordType } from './types';
 
-export enum NsApplicationRecordType {
-	// installed
-	Installed = 0x3,
-	// application is gamecard, but gamecard isn't insterted
-	GamecardMissing = 0x5,
-	// archived
-	Archived = 0xb,
-}
+export * from './types';
 
 const nsAm2 = new Switch.Service('ns:am2');
 const nsAppManSrv = new Switch.Service();

packages/ns/src/types.ts

@@ -0,0 +1,8 @@
+export enum NsApplicationRecordType {
+	// installed
+	Installed = 0x3,
+	// application is gamecard, but gamecard isn't insterted
+	GamecardMissing = 0x5,
+	// archived
+	Archived = 0xb,
+}

packages/ns/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "es2022",
+    "declaration": true,
+    "sourceMap": true,
+    "moduleResolution": "Bundler",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "types": [
+      "@nx.js/runtime"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

packages/ns/typedoc.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "extends": ["../../typedoc.json"],
+  "name": "@nx.js/ns",
+  "entryPoints": ["./src/index.ts"],
+  "out": "docs"
+}