@ausecon/core 0.0.0-stage → 0.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 Jack McPherson
+Copyright (c) 2018 Zoe Meers and Matt Cowgill (readabs)
+Copyright (c) 2020 Matt Cowgill (readrba)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# `@ausecon/core`
 
-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.
+`@ausecon/core` is a TypeScript library that reads Australian economic data
+from the Australian Bureau of Statistics (ABS) and the Reserve Bank of
+Australia (RBA). It ports the `readabs` and `readrba` R packages and uses
+[Effect](https://effect.website).
+
+The library uses no Node, Bun, or Deno APIs. It runs on Node 22.18 or later,
+Bun, and Deno.
+
+---
+
+## Status
+
+The library is in development. No release exists.
+
+The first release reads ABS time series by catalogue number and table number,
+or by series ID. The package now exports these schemas and errors:
+
+- `CatalogueNumber`, such as `6202.0` or `6291.0.55.001`
+- `SeriesId`, such as `A84423050A`
+- `TableNumber`, such as `1`, `5a`, or `X28`
+- `SeriesNotFound`, the error when the Time Series Directory has no record of
+  a series
+
+```ts
+import { CatalogueNumber } from "@ausecon/core";
+import { Schema } from "effect";
+
+Schema.is(CatalogueNumber)("6202.0"); // true
+Schema.is(CatalogueNumber)("6202"); // false
+```
+
+## Install
+
+```shell
+npm install @ausecon/core effect
+```
+
+## Links
+
+- [Command-line tool](https://www.npmjs.com/package/ausecon)
+- [Source and glossary](https://github.com/jackemcpherson/ausecon)
+- [`readabs` R package](https://github.com/MattCowgill/readabs)
+- [`readrba` R package](https://github.com/MattCowgill/readrba)
+
+## License
+
+MIT. The license keeps the copyright notices of `readabs` and `readrba`.

package/dist/index.d.ts

@@ -0,0 +1,28 @@
+import { Schema } from "effect";
+/**
+ * An ABS catalogue number, such as `6202.0` or `6291.0.55.001`.
+ */
+export declare const CatalogueNumber: Schema.brand<Schema.String, "CatalogueNumber">;
+/** A decoded ABS catalogue number. */
+export type CatalogueNumber = typeof CatalogueNumber.Type;
+/**
+ * An ABS series ID, such as `A84423050A`.
+ */
+export declare const SeriesId: Schema.brand<Schema.String, "SeriesId">;
+/** A decoded ABS series ID. */
+export type SeriesId = typeof SeriesId.Type;
+/**
+ * The number in the ABS title of a table, such as `1`, `5a`, `X28`, or
+ * `021_MTH`.
+ */
+export declare const TableNumber: Schema.brand<Schema.String, "TableNumber">;
+/** A decoded ABS table number. */
+export type TableNumber = typeof TableNumber.Type;
+declare const SeriesNotFound_base: Schema.Class<SeriesNotFound, Schema.TaggedStruct<"SeriesNotFound", {
+  readonly seriesIds: Schema.$Array<Schema.brand<Schema.String, "SeriesId">>;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * The Time Series Directory has no record of one or more requested series.
+ */
+export declare class SeriesNotFound extends SeriesNotFound_base {}
+export {};

package/dist/index.js

@@ -0,0 +1,20 @@
+import { Schema } from "effect";
+// src/types.ts
+/**
+* An ABS catalogue number, such as `6202.0` or `6291.0.55.001`.
+*/
+const CatalogueNumber = Schema.String.pipe(Schema.check(Schema.isPattern(/^\d{4}\.\d(?:\.\d{2}\.\d{3})?$/)), Schema.brand("CatalogueNumber"));
+/**
+* An ABS series ID, such as `A84423050A`.
+*/
+const SeriesId = Schema.String.pipe(Schema.check(Schema.isPattern(/^[A-Z]\d+[A-Z]$/)), Schema.brand("SeriesId"));
+/**
+* The number in the ABS title of a table, such as `1`, `5a`, `X28`, or
+* `021_MTH`.
+*/
+const TableNumber = Schema.String.pipe(Schema.check(Schema.isPattern(/^[A-Z]?\d+[A-Za-z]?(?:_[A-Za-z0-9]+)?$/)), Schema.brand("TableNumber"));
+/**
+* The Time Series Directory has no record of one or more requested series.
+*/
+var SeriesNotFound = class extends Schema.TaggedError()("SeriesNotFound", { seriesIds: Schema.Array(SeriesId) }) {};
+export { CatalogueNumber, SeriesId, SeriesNotFound, TableNumber };

package/package.json

@@ -1,6 +1,32 @@
 {
   "name": "@ausecon/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.0",
+  "description": "Read Australian economic data from the ABS and RBA.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jackemcpherson/ausecon.git",
+    "directory": "packages/core"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "vp pack"
+  },
+  "dependencies": {
+    "effect": "4.0.6",
+    "xlsx": "https://cdn.sheetjs.com/xlsx-0.20.3/xlsx-0.20.3.tgz"
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  }
+}