@khanacademy/wonder-blocks-config 0.0.1 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @khanacademy/wonder-blocks-config
+
+## 0.2.0
+
+### Minor Changes
+
+- 2e7983b: Export `defaultStringsEn` from the package entry point
+
+## 0.1.0
+
+### Minor Changes
+
+- e17fe69: Adds WonderBlocksConfigProvider for the initial set up for built in i18n support in Wonder Blocks components.
+
+### Patch Changes
+
+- fe03ec2: Sets up the wonder-blocks-config package

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Khan Academy
+
+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,5 +1,3 @@
 # @khanacademy/wonder-blocks-config
 
-This package is being published as a placeholder for the `@khanacademy/wonder-blocks-config`
-library. This will enable us to configure Trusted Publishing (which can't be
-enabled until the package has been published at least once).
+This package is for configuring Wonder Blocks.

package/dist/components/wonder-blocks-config-provider.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import type { I18nConfig } from "../context/i18n-context";
+type Props = React.PropsWithChildren<{
+    /**
+     * The strings for Wonder Blocks components to render, and the locale they
+     * are translated into.
+     */
+    i18n: I18nConfig;
+}>;
+/**
+ * Configures the Wonder Blocks components rendered beneath it.
+ */
+export declare function WonderBlocksConfigProvider({ children, i18n }: Props): React.JSX.Element;
+export {};

package/dist/context/i18n-context.d.ts

@@ -0,0 +1,28 @@
+import * as React from "react";
+import type { WonderBlocksStrings } from "../strings";
+/**
+ * The i18n configuration for Wonder Blocks components
+ */
+export type I18nConfig = {
+    /**
+     * The translated strings that Wonder Blocks components render.
+     */
+    strings: WonderBlocksStrings;
+    /**
+     * The locale `strings` are translated into.
+     */
+    locale: string;
+};
+/**
+ * Context for strings and locale information for Wonder Blocks components.
+ *
+ * Defaults to English translations if not provided.
+ */
+export declare const WonderBlocksI18nContext: React.Context<I18nConfig>;
+type Props = React.PropsWithChildren<I18nConfig>;
+/**
+ * Provides i18n to Wonder Blocks components.
+ */
+export declare function WonderBlocksI18nContextProvider({ children, strings, locale, }: Props): React.JSX.Element;
+export declare const useWonderBlocksI18n: () => I18nConfig;
+export {};

package/dist/es/index.js

@@ -0,0 +1,11 @@
+import { jsx } from 'react/jsx-runtime';
+import * as React from 'react';
+import { useContext, useMemo } from 'react';
+
+const strings={iconAltOpensNewTab:{context:"Accessible name for an icon marking a link that opens in a new tab.",message:"(opens in a new tab)"}};const defaultStringsEn={iconAltOpensNewTab:strings.iconAltOpensNewTab.message};
+
+const WonderBlocksI18nContext=React.createContext({strings:defaultStringsEn,locale:"en"});WonderBlocksI18nContext.displayName="WonderBlocksI18nContext";function WonderBlocksI18nContextProvider({children,strings,locale}){const value=useMemo(()=>({strings,locale}),[strings,locale]);return jsx(WonderBlocksI18nContext.Provider,{value:value,children:children})}const useWonderBlocksI18n=()=>useContext(WonderBlocksI18nContext);
+
+function WonderBlocksConfigProvider({children,i18n}){const{strings,locale}=i18n;return jsx(WonderBlocksI18nContextProvider,{strings:strings,locale:locale,children:children})}
+
+export { WonderBlocksConfigProvider, defaultStringsEn, useWonderBlocksI18n };

package/dist/es/strings.js

@@ -0,0 +1,3 @@
+const strings={iconAltOpensNewTab:{context:"Accessible name for an icon marking a link that opens in a new tab.",message:"(opens in a new tab)"}};const defaultStringsEn={iconAltOpensNewTab:strings.iconAltOpensNewTab.message};
+
+export { defaultStringsEn, strings };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { WonderBlocksConfigProvider } from "./components/wonder-blocks-config-provider";
+export { useWonderBlocksI18n } from "./context/i18n-context";
+export type { I18nConfig } from "./context/i18n-context";
+export { defaultStringsEn } from "./strings";
+export type { WonderBlocksStrings } from "./strings";

package/dist/index.js

@@ -0,0 +1,36 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var jsxRuntime = require('react/jsx-runtime');
+var React = require('react');
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+
+const strings={iconAltOpensNewTab:{context:"Accessible name for an icon marking a link that opens in a new tab.",message:"(opens in a new tab)"}};const defaultStringsEn={iconAltOpensNewTab:strings.iconAltOpensNewTab.message};
+
+const WonderBlocksI18nContext=React__namespace.createContext({strings:defaultStringsEn,locale:"en"});WonderBlocksI18nContext.displayName="WonderBlocksI18nContext";function WonderBlocksI18nContextProvider({children,strings,locale}){const value=React.useMemo(()=>({strings,locale}),[strings,locale]);return jsxRuntime.jsx(WonderBlocksI18nContext.Provider,{value:value,children:children})}const useWonderBlocksI18n=()=>React.useContext(WonderBlocksI18nContext);
+
+function WonderBlocksConfigProvider({children,i18n}){const{strings,locale}=i18n;return jsxRuntime.jsx(WonderBlocksI18nContextProvider,{strings:strings,locale:locale,children:children})}
+
+exports.WonderBlocksConfigProvider = WonderBlocksConfigProvider;
+exports.defaultStringsEn = defaultStringsEn;
+exports.useWonderBlocksI18n = useWonderBlocksI18n;

package/dist/strings.d.ts

@@ -0,0 +1,22 @@
+/**
+ * The translated strings that are used to render Wonder Blocks.
+ */
+export type WonderBlocksStrings = {
+    iconAltOpensNewTab: string;
+};
+/**
+ * Untranslated strings used in Wonder Blocks. To be used by an external
+ * translator to produce translated strings, passed in as `WonderBlocksStrings`.
+ *
+ * !! Note: Ensure that all escape sequences are double-escaped. (e.g. `\\text` -> `\\\\text`)
+ */
+export declare const strings: {
+    iconAltOpensNewTab: {
+        context: string;
+        message: string;
+    };
+};
+/**
+ * Default 'en' strings to use.
+ */
+export declare const defaultStringsEn: WonderBlocksStrings;

package/dist/strings.js

@@ -0,0 +1,8 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const strings={iconAltOpensNewTab:{context:"Accessible name for an icon marking a link that opens in a new tab.",message:"(opens in a new tab)"}};const defaultStringsEn={iconAltOpensNewTab:strings.iconAltOpensNewTab.message};
+
+exports.defaultStringsEn = defaultStringsEn;
+exports.strings = strings;

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@khanacademy/wonder-blocks-config",
-  "description": "Placeholder to allow Trusted Publishing configuration",
+  "description": "Configuration for Wonder Blocks",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "0.0.1",
+  "version": "0.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -14,6 +14,30 @@
   "bugs": {
     "url": "https://github.com/Khan/wonder-blocks/issues"
   },
-  "module": "index.js",
-  "main": "index.js"
+  "main": "dist/index.js",
+  "module": "dist/es/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "import": "./dist/es/index.js",
+      "require": "./dist/index.js"
+    },
+    "./strings": {
+      "types": "./dist/strings.d.ts",
+      "source": "./src/strings.ts",
+      "import": "./dist/es/strings.js",
+      "require": "./dist/strings.js"
+    }
+  },
+  "peerDependencies": {
+    "react": "18.2.0"
+  },
+  "devDependencies": {
+    "@khanacademy/wb-dev-build-settings": "3.3.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
 }

package/index.js

@@ -1 +0,0 @@
-throw new Error("Not implemented");