netscry 0.0.0-stage → 0.1.0

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 NetScry contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,35 @@
1
- # Temporary Holding Version
1
+ # `netscry`
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The top-level NetScry npm package. It brings together `@netscry/core`, `@netscry/schemas`, and `@netscry/sdk` behind one unscoped import. The scoped packages remain independently installable.
4
+
5
+ ## Usage
6
+
7
+ ```ts
8
+ import { Effect } from "effect";
9
+ import { sdk } from "netscry";
10
+
11
+ const client = sdk.createNetScryClient({
12
+ baseUrl: "https://netscry.mynameistito.com",
13
+ });
14
+
15
+ const health = await Effect.runPromise(client.health());
16
+ ```
17
+
18
+ The other package APIs are available under `core` and `schemas`:
19
+
20
+ ```ts
21
+ import { core, schemas } from "netscry";
22
+
23
+ const address = core.parseIpAddress("1.1.1.1");
24
+ const healthSchema = schemas.ApiHealthResponseSchema;
25
+ ```
26
+
27
+ The client uses standard Fetch APIs, validates responses against the shared contracts, and returns Effects with typed SDK failures. `me()` reports the IP address of the request reaching NetScry; when called from a server, this is generally the server's egress IP, not its original visitor's IP.
28
+
29
+ ## Runtime and package contents
30
+
31
+ The package supports Node.js 20 or newer and other runtimes with standard Fetch APIs. Its npm tarball contains the ESM entry point, TypeScript declarations, README, and MIT license only.
32
+
33
+ ## Development
34
+
35
+ From the repository root, run `bun run build:packages` to build all workspace libraries. `bun run verify:packages` also exercises this package from Node without Bun workspace source aliases.
@@ -0,0 +1,2 @@
1
+ export { NetScrySdkError, createNetScryClient } from "@netscry/sdk";
2
+ export type { NetScryClient, NetScryClientOptions, NetScryFetch, } from "@netscry/sdk";
package/dist/index.js ADDED
@@ -0,0 +1 @@
1
+ export { NetScrySdkError, createNetScryClient } from "@netscry/sdk";
package/package.json CHANGED
@@ -1,6 +1,41 @@
1
1
  {
2
2
  "name": "netscry",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.1.0",
4
+ "homepage": "https://github.com/mynameistito/netscry#readme",
5
+ "bugs": {
6
+ "url": "https://github.com/mynameistito/netscry/issues"
7
+ },
8
+ "license": "MIT",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/mynameistito/netscry.git",
12
+ "directory": "packages/netscry"
13
+ },
14
+ "files": [
15
+ "dist",
16
+ "LICENSE"
17
+ ],
18
+ "type": "module",
19
+ "sideEffects": false,
20
+ "exports": {
21
+ ".": {
22
+ "types": "./dist/index.d.ts",
23
+ "bun": "./src/index.ts",
24
+ "development": "./src/index.ts",
25
+ "import": "./dist/index.js",
26
+ "default": "./dist/index.js"
27
+ }
28
+ },
29
+ "scripts": {
30
+ "build": "tsc -p tsconfig.build.json",
31
+ "test:consumer": "node test/consumer.mjs"
32
+ },
33
+ "dependencies": {
34
+ "@netscry/core": "^0.1.1",
35
+ "@netscry/schemas": "^0.1.1",
36
+ "@netscry/sdk": "^0.1.1"
37
+ },
38
+ "engines": {
39
+ "node": ">=20"
40
+ }
41
+ }