weekly-fifty 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2025 Reuben Roessler. All rights reserved.
+
+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

@@ -0,0 +1,31 @@
+# The Weekly Fifty Library
+
+Allows safely fetching [The Weekly Fifty](https://theweeklyfifty.com.au/) latests quizzes.
+
+## Installation
+
+```shell
+npm install weekly-fifty
+```
+
+## Usage
+
+To use this library, the following is available:
+
+```typescript
+import { TW50 } from 'weekly-fifty';
+
+// get the latest available quiz
+const latest = await TW50.Fetch();
+```
+
+### Options
+
+The `Options` available for `TW50.Fetch` include:
+
+-   `url`: Optional override url for the quiz endpoint.
+-   `parse`: Handles parsing fetch responses to quiz data.
+
+## License
+
+[MIT](LICENSE)

package/dist/index.cjs

@@ -0,0 +1,89 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// source/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TW50: () => exports_exports
+});
+module.exports = __toCommonJS(index_exports);
+
+// source/_exports.ts
+var exports_exports = {};
+__export(exports_exports, {
+  Fetch: () => Fetch
+});
+
+// source/fetch/index.ts
+var import_myzod = __toESM(require("myzod"), 1);
+async function Fetch(options = {}) {
+  const { url, parse } = Fetch.Options(options);
+  return fetch(url).then(parse);
+}
+((Fetch2) => {
+  const m_timestamp = import_myzod.default.object({ _seconds: import_myzod.default.required(import_myzod.default.number()), _nanoseconds: import_myzod.default.required(import_myzod.default.number()) }, { allowUnknown: true }).map(({ _seconds, _nanoseconds }) => new Date(_seconds * 1e3 + _nanoseconds * 1e6));
+  const m_question = import_myzod.default.object({ qTitle: import_myzod.default.required(import_myzod.default.string()), qAnswer: import_myzod.default.required(import_myzod.default.string()) }, { allowUnknown: true }).map(({ qTitle, qAnswer }) => ({ title: qTitle, answer: qAnswer }));
+  const m_quiz = import_myzod.default.object(
+    {
+      quizId: import_myzod.default.required(import_myzod.default.number()),
+      quizType: import_myzod.default.required(import_myzod.default.number()),
+      quizTitle: import_myzod.default.required(import_myzod.default.string()),
+      notesAbove: import_myzod.default.required(import_myzod.default.string()),
+      notesBelow: import_myzod.default.required(import_myzod.default.string()),
+      creationTime: import_myzod.default.required(m_timestamp),
+      deploymentDate: import_myzod.default.required(m_timestamp),
+      questions: import_myzod.default.required(import_myzod.default.array(m_question))
+    },
+    { allowUnknown: true }
+  ).map(
+    (api) => ({
+      id: api.quizId,
+      type: api.quizType,
+      title: api.quizTitle,
+      questions: api.questions,
+      creation: api.creationTime,
+      deployment: api.deploymentDate,
+      notes: { above: api.notesAbove, below: api.notesBelow }
+    })
+  );
+  Fetch2.Options = (options = {}) => ({
+    url: "https://weeklyfifty-7617b.web.app/api/getLatestQuiz",
+    parse: m_parse,
+    ...options
+  });
+  const m_parse = async (response) => {
+    const ct = response.headers.get("content-type");
+    if (ct && ct.indexOf("application/json") === -1) throw new TypeError("Expected JSON response");
+    return response.json().then((data) => m_quiz.parse(data));
+  };
+})(Fetch || (Fetch = {}));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TW50
+});

package/dist/index.d.cts

@@ -0,0 +1,48 @@
+/** Question Output Typing. */
+interface Question {
+    readonly title: string;
+    readonly answer: string;
+}
+/** Notes Output Typing. */
+interface Notes {
+    readonly above: string;
+    readonly below: string;
+}
+/** Quiz Output Typing. */
+interface Quiz {
+    readonly id: number;
+    readonly type: number;
+    readonly title: string;
+    readonly notes: Notes;
+    readonly creation: Date;
+    readonly deployment: Date;
+    readonly questions: ReadonlyArray<Question>;
+}
+
+/** Handles Fetching Quizzes. */
+declare function Fetch(options?: Fetch.Options): Promise<Quiz>;
+declare namespace Fetch {
+    /** Available Fetch Options. */
+    interface Options {
+        /** Overridable endpoint for quizzes. */
+        readonly url?: string;
+        /** Handles parsing incoming quizzes. */
+        readonly parse?: (response: Response) => Quiz | Promise<Quiz>;
+    }
+    /**
+     * Handles resolving options to be used.
+     * @param options
+     * @returns
+     */
+    const Options: (options?: Options) => Required<Options>;
+}
+
+declare const _exports_Fetch: typeof Fetch;
+type _exports_Notes = Notes;
+type _exports_Question = Question;
+type _exports_Quiz = Quiz;
+declare namespace _exports {
+  export { _exports_Fetch as Fetch, type _exports_Notes as Notes, type _exports_Question as Question, type _exports_Quiz as Quiz };
+}
+
+export { _exports as TW50 };

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+/** Question Output Typing. */
+interface Question {
+    readonly title: string;
+    readonly answer: string;
+}
+/** Notes Output Typing. */
+interface Notes {
+    readonly above: string;
+    readonly below: string;
+}
+/** Quiz Output Typing. */
+interface Quiz {
+    readonly id: number;
+    readonly type: number;
+    readonly title: string;
+    readonly notes: Notes;
+    readonly creation: Date;
+    readonly deployment: Date;
+    readonly questions: ReadonlyArray<Question>;
+}
+
+/** Handles Fetching Quizzes. */
+declare function Fetch(options?: Fetch.Options): Promise<Quiz>;
+declare namespace Fetch {
+    /** Available Fetch Options. */
+    interface Options {
+        /** Overridable endpoint for quizzes. */
+        readonly url?: string;
+        /** Handles parsing incoming quizzes. */
+        readonly parse?: (response: Response) => Quiz | Promise<Quiz>;
+    }
+    /**
+     * Handles resolving options to be used.
+     * @param options
+     * @returns
+     */
+    const Options: (options?: Options) => Required<Options>;
+}
+
+declare const _exports_Fetch: typeof Fetch;
+type _exports_Notes = Notes;
+type _exports_Question = Question;
+type _exports_Quiz = Quiz;
+declare namespace _exports {
+  export { _exports_Fetch as Fetch, type _exports_Notes as Notes, type _exports_Question as Question, type _exports_Quiz as Quiz };
+}
+
+export { _exports as TW50 };

package/dist/index.js

@@ -0,0 +1,58 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// source/_exports.ts
+var exports_exports = {};
+__export(exports_exports, {
+  Fetch: () => Fetch
+});
+
+// source/fetch/index.ts
+import z from "myzod";
+async function Fetch(options = {}) {
+  const { url, parse } = Fetch.Options(options);
+  return fetch(url).then(parse);
+}
+((Fetch2) => {
+  const m_timestamp = z.object({ _seconds: z.required(z.number()), _nanoseconds: z.required(z.number()) }, { allowUnknown: true }).map(({ _seconds, _nanoseconds }) => new Date(_seconds * 1e3 + _nanoseconds * 1e6));
+  const m_question = z.object({ qTitle: z.required(z.string()), qAnswer: z.required(z.string()) }, { allowUnknown: true }).map(({ qTitle, qAnswer }) => ({ title: qTitle, answer: qAnswer }));
+  const m_quiz = z.object(
+    {
+      quizId: z.required(z.number()),
+      quizType: z.required(z.number()),
+      quizTitle: z.required(z.string()),
+      notesAbove: z.required(z.string()),
+      notesBelow: z.required(z.string()),
+      creationTime: z.required(m_timestamp),
+      deploymentDate: z.required(m_timestamp),
+      questions: z.required(z.array(m_question))
+    },
+    { allowUnknown: true }
+  ).map(
+    (api) => ({
+      id: api.quizId,
+      type: api.quizType,
+      title: api.quizTitle,
+      questions: api.questions,
+      creation: api.creationTime,
+      deployment: api.deploymentDate,
+      notes: { above: api.notesAbove, below: api.notesBelow }
+    })
+  );
+  Fetch2.Options = (options = {}) => ({
+    url: "https://weeklyfifty-7617b.web.app/api/getLatestQuiz",
+    parse: m_parse,
+    ...options
+  });
+  const m_parse = async (response) => {
+    const ct = response.headers.get("content-type");
+    if (ct && ct.indexOf("application/json") === -1) throw new TypeError("Expected JSON response");
+    return response.json().then((data) => m_quiz.parse(data));
+  };
+})(Fetch || (Fetch = {}));
+export {
+  exports_exports as TW50
+};

package/package.json

@@ -0,0 +1,38 @@
+{
+    "type": "module",
+    "license": "MIT",
+    "version": "1.0.0",
+    "name": "weekly-fifty",
+    "author": "Reuben Roessler",
+    "repository": "rroessler/npm.weekly-fifty",
+    "description": "Library for fetching 'The Weekly Fifty' quizzes",
+    "main": "./dist/index.cjs",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        "types": "./dist/index.d.ts",
+        "import": "./dist/index.mjs",
+        "require": "./dist/index.cjs"
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "//  BUILD  //": "",
+        "build": "tsup ./source/index.ts --dts --format esm,cjs",
+        "//  PACKAGE  //": "",
+        "publish": "run-s build publish:np",
+        "publish:np": "np"
+    },
+    "dependencies": {
+        "myzod": "^1.12.1"
+    },
+    "devDependencies": {
+        "@tsconfig/recommended": "^1.0.13",
+        "np": "^10.2.0",
+        "npm-run-all2": "^8.0.4",
+        "tsup": "^8.5.1",
+        "tsx": "^4.20.6",
+        "typescript": "^5.9.3"
+    }
+}