Consolidate @zarrita/core into zarrita (#269)

Author: manzt

.changeset/new-peaches-share.md

@@ -0,0 +1,8 @@
+---
+"@zarrita/core": patch
+"@zarrita/ndarray": patch
+"@zarrita/storage": patch
+"zarrita": patch
+---
+
+Consolidate @zarrita/core into zarrita

.github/workflows/jsr.yml

@@ -19,16 +19,16 @@ jobs:
 
       - name: Publish @zarrita/storage
         run: deno publish --unstable-sloppy-imports
-        working-directory: packages/storage
-
-      - name: Publish @zarrita/core
-        run: deno publish --unstable-sloppy-imports
-        working-directory: packages/core
+        working-directory: packages/@zarrita-storage
 
       - name: Publish @zarrita/zarrita
         run: deno publish --unstable-sloppy-imports
         working-directory: packages/zarrita
 
+      - name: Publish @zarrita/core
+        run: deno publish --unstable-sloppy-imports
+        working-directory: packages/@zarrita-core
+
       - name: Publish @zarrita/ndarray
         run: deno publish --unstable-sloppy-imports
-        working-directory: packages/ndarray
+        working-directory: packages/@zarrita-ndarray

demo.html

@@ -6,8 +6,7 @@
     <script type="importmap">
       {
         "imports": {
-          "zarrita": "./packages/zarrita/dist/index.js",
-          "@zarrita/core": "./packages/core/dist/src/index.js",
+          "zarrita": "./packages/zarrita/dist/src/index.js",
           "@zarrita/storage/fetch": "./packages/storage/dist/src/fetch.js",
           "numcodecs/blosc": "./packages/core/node_modules/numcodecs/blosc.js",
           "numcodecs/lz4": "./packages/core/node_modules/numcodecs/lz4.js",

docs/get-started.md

@@ -75,7 +75,6 @@ automatically loads the other dependencies.
   {
     "imports": {
       "zarrita": "https://unpkg.com/zarrita@next",
-      "@zarrita/core": "https://unpkg.com/@zarrita/core@next",
       "@zarrita/storage/fetch": "https://unpkg.com/@zarrita/storage@next/dist/src/fetch.js",
       "numcodecs/blosc": "https://unpkg.com/numcodecs@0.3/blosc",
       "numcodecs/lz4": "https://unpkg.com/numcodecs@0.3/lz4",

docs/packages/core.md docs/packages/zarrita.mddocs/packages/core.md renamed to docs/packages/zarrita.md

@@ -1,4 +1,4 @@
-# @zarrita/core
+# zarrita
 
 The primary engine for interacting with Zarr in JavaScript. Navigate a store
 hierarchy and load individual array chunks.
@@ -42,16 +42,15 @@ array chunks on-demand.
 
 ## Navigation
 
-The **@zarrita/core** module introduces a `Location` primitive to navigate
+The **zarrita** module introduces a `Location` primitive to navigate
 through a storage hierarchy. This object associates a **path** with a **store**
 (i.e., a specific location in the hierarchy), and exposes a useful `resolve`
 helper:
 
 ```javascript
-import * as zarr from "@zarrita/core";
-import { FetchStore } from "@zarrita/storage";
+import * as zarr from "zarrita";
 
-let root = zarr.root(new FetchStore("http://localhost:8080/data.zarr"));
+let root = zarr.root(new zarr.FetchStore("http://localhost:8080/data.zarr"));
 root.store; // FetchStore
 root.path; // "/"
 
@@ -69,10 +68,9 @@ foo.path; // "/foo"
 Using a `Location`, you can access an **array** or **group** with `open`:
 
 ```javascript
-import * as zarr from "@zarrita/core";
-import { FetchStore } from "@zarrita/storage";
+import * as zarr from "zarrita";
 
-let root = zarr.root(new FetchStore("http://localhost:8080/data.zarr"));
+let root = zarr.root(new zarr.FetchStore("http://localhost:8080/data.zarr"));
 let node = await zarr.open(root);
 node; // zarr.Array<DataType, FetchStore> | zarr.Group
 ```
@@ -142,7 +140,7 @@ view.get(1, 3); // 7
 Given a `Location`, you can also create an **array** or **group** with `create`:
 
 ```javascript
-import * as zarr from "@zarrita/core";
+import * as zarr from "zarrita";
 
 let root = zarr.root(new Map());
 let grp = await zarr.create(root);
@@ -170,7 +168,7 @@ While slicing and indexing are foundational concepts as in Zarr, they are
 presented through a higher-level (optional) API in **zarrita**. This choice
 caters to applications that might prefer direct interaction with chunks.
 
-You can use either **@zarrita/core** or **@zarrita/ndarray** to conveniently
+You can use either **zarrita** or **@zarrita/ndarray** to conveniently
 access specific data subsets without thinking about chunking details.
 
 ### How to slice
@@ -212,12 +210,12 @@ region = arr[10:20, ..., 0]
 ## Data Typing in TypeScript
 
 Zarr's dynamic nature presents a challenge in accurately representing data types
-to static type systems. **@zarrita/core** leverages TypeScript's advanced typing
+to static type systems. **zarrita** leverages TypeScript's advanced typing
 capabilities to extract and communicate Zarr `data_type` metadata across its
 APIs.
 
 In essense, you (moreover your editor) is always informed about the data types
-at hand when working with Zarr via **@zarrita/core**. TypeScript assists in
+at hand when working with Zarr via **zarrita**. TypeScript assists in
 covering edge cases, but (importantly) steps back once you've demonstrated data
 correctness.
 
@@ -259,7 +257,7 @@ But what about when the data type isn't known? Let's say we now `open` a remote
 Zarr array:
 
 ```javascript
-let store = new FetchStore("http://localhost:8080/data.zarr");
+let store = new zarr.FetchStore("http://localhost:8080/data.zarr");
 let arr = await zarr.open(store);
 let chunk = await arr.getChunk([0, 0]);
 
@@ -289,8 +287,7 @@ Instead, wouldn't it be convenient if you could verify the data type once, and
 then TypeScript would automatically understand the expected data type for all
 subsequent `getChunk` calls?
 
-**@zarrita/core** introduces the `zarr.Array.is` type guard to achieve just
-that:
+**zarrita** introduces the `zarr.Array.is` type guard to achieve just that:
 
 ```javascript
 if (!arr.is("int64") || !arr.is("uint64")) {

docs/what-is-zarrita.md

@@ -29,7 +29,7 @@ allows **zarrita** to be both <u>minimal and feature complete</u> if necessary.
 **zarrita** is broken down into several packages to create and interact with
 Zarr.
 
-### [@zarrita/core](/packages/core)
+### [zarrita](/packages/zarrita)
 
 - Navigate a storage hierarchy and `open` or `create` **groups** and **arrays**.
 - Load individual array **chunks** on-demand based on their key.