@instructure/platform-cohorts 0.1.0

package/README.md

@@ -0,0 +1,30 @@
+# @instructure/platform-cohorts
+
+Cohort management UI for Canvas.
+
+Cohorts is a new domain model for grouping users into hierarchical groups agnostic of the account structure that powers exactly six things:
+- enrollment into courses
+- enrollment into programs
+- enrollment into collections
+- targeted global announcements
+- targeted learner dashboards
+- filtered reporting
+
+This package is the **foundational** slice of that work. Per-product extensions belong in the consuming app, not here.
+
+Read more: [`docs/tech-spec.md`](./docs/tech-spec.md) (reference copy).
+
+The REST contract lives in [`openapi.yaml`](./openapi.yaml) and is the source of truth for every API operation this package performs.
+
+## Development
+
+Everything runs from the monorepo root unless noted.
+
+```bash
+pnpm install                                        # link the package into the workspace
+pnpm storybook                                      # http://localhost:6006 — the dev loop
+pnpm --filter @instructure/platform-cohorts test     # vitest + coverage
+pnpm --filter @instructure/platform-cohorts build    # vite lib build + .d.ts
+pnpm --filter @instructure/platform-cohorts type-check
+pnpm lint                                            # biome + oxlint + ast-grep
+```

package/dist/components/CohortsHelloWorld.d.ts

@@ -0,0 +1,3 @@
+import { ReactNode } from 'react';
+export declare function CohortsHelloWorld(): ReactNode;
+//# sourceMappingURL=CohortsHelloWorld.d.ts.map

package/dist/components/CohortsHelloWorld.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CohortsHelloWorld.d.ts","sourceRoot":"","sources":["../../src/components/CohortsHelloWorld.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAGtC,wBAAgB,iBAAiB,IAAI,SAAS,CAG7C"}

package/dist/i18n.d.ts

@@ -0,0 +1,25 @@
+import { ReactNode } from 'react';
+import { default as en } from '../locales/en.json';
+/** Every key the catalog ships. Type translated props as this, never as `string`. */
+export type CohortsTranslationKey = keyof typeof en;
+export type PluralForms = Partial<Record<Intl.LDMLPluralRule, string>>;
+/** A host supplies as few or as many keys as it likes; the rest fall back to English. */
+export type CohortsTranslations = Partial<Record<CohortsTranslationKey, PluralForms | string>>;
+export type TranslateFunction = (key: CohortsTranslationKey, options?: Record<string, unknown>) => string;
+export declare const DEFAULT_LOCALE = "en-US";
+export declare function createTranslate(translations?: CohortsTranslations, locale?: string): TranslateFunction;
+export declare const defaultTranslate: TranslateFunction;
+export interface CohortsI18n {
+    t: TranslateFunction;
+    locale: string;
+    timezone?: string;
+}
+export interface CohortsI18nProviderProps {
+    translations?: CohortsTranslations;
+    locale?: string;
+    timezone?: string;
+    children: ReactNode;
+}
+export declare function CohortsI18nProvider({ translations, locale, timezone, children, }: CohortsI18nProviderProps): ReactNode;
+export declare function useCohortsI18n(): CohortsI18n;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"i18n.d.ts","sourceRoot":"","sources":["../src/i18n.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAA;AAC1E,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAEnC,qFAAqF;AACrF,MAAM,MAAM,qBAAqB,GAAG,MAAM,OAAO,EAAE,CAAA;AAEnD,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAA;AAEtE,yFAAyF;AACzF,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,qBAAqB,EAAE,WAAW,GAAG,MAAM,CAAC,CAAC,CAAA;AAE9F,MAAM,MAAM,iBAAiB,GAAG,CAC9B,GAAG,EAAE,qBAAqB,EAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAC9B,MAAM,CAAA;AAMX,eAAO,MAAM,cAAc,UAAU,CAAA;AAoDrC,wBAAgB,eAAe,CAC7B,YAAY,CAAC,EAAE,mBAAmB,EAClC,MAAM,GAAE,MAAuB,GAC9B,iBAAiB,CAQnB;AAED,eAAO,MAAM,gBAAgB,EAAE,iBAAqC,CAAA;AAEpE,MAAM,WAAW,WAAW;IAC1B,CAAC,EAAE,iBAAiB,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAMD,MAAM,WAAW,wBAAwB;IACvC,YAAY,CAAC,EAAE,mBAAmB,CAAA;IAClC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,mBAAmB,CAAC,EAClC,YAAY,EACZ,MAAM,EACN,QAAQ,EACR,QAAQ,GACT,EAAE,wBAAwB,GAAG,SAAS,CAMtC;AAED,wBAAgB,cAAc,IAAI,WAAW,CAE5C"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { CohortsHelloWorld } from './components/CohortsHelloWorld';
+export { type CohortsI18n, CohortsI18nProvider, type CohortsI18nProviderProps, type CohortsTranslationKey, type CohortsTranslations, createTranslate, DEFAULT_LOCALE, defaultTranslate, type PluralForms, type TranslateFunction, useCohortsI18n, } from './i18n';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAA;AAClE,OAAO,EACL,KAAK,WAAW,EAChB,mBAAmB,EACnB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,EACxB,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,KAAK,WAAW,EAChB,KAAK,iBAAiB,EACtB,cAAc,GACf,MAAM,QAAQ,CAAA"}

package/dist/index.js

@@ -0,0 +1,65 @@
+import { jsx as f } from "react/jsx-runtime";
+import { Text as d } from "@instructure/ui-text";
+import { createContext as h, useMemo as p, useContext as C } from "react";
+const b = "Hello World", F = {
+  helloWorld: b
+}, a = /%\{(\w+)\}/g, v = F, c = "en-US", A = /* @__PURE__ */ new Map(), L = /* @__PURE__ */ new Map();
+function s(t, e, r) {
+  const n = t.get(e);
+  if (n) return n;
+  const o = r();
+  return t.set(e, o), o;
+}
+function T(t, e, r) {
+  return r ? t.replace(a, (n, o) => {
+    if (!Object.prototype.hasOwnProperty.call(r, o)) return n;
+    const u = r[o];
+    return typeof u == "number" ? Number.isFinite(u) ? s(L, e, () => new Intl.NumberFormat(e)).format(u) : n : String(u);
+  }) : t;
+}
+function g(t, e, r) {
+  const n = r == null ? void 0 : r.count;
+  if (typeof n == "number" && Number.isFinite(n)) {
+    const o = s(A, e, () => new Intl.PluralRules(e)).select(n), u = t[o];
+    if (typeof u == "string") return u;
+  }
+  return t.other;
+}
+function l(t, e, r) {
+  if (t !== void 0)
+    return typeof t == "string" ? t : g(t, e, r);
+}
+function i(t, e = c) {
+  return (r, n) => {
+    const o = l(t == null ? void 0 : t[r], e, n) ?? l(v[r], e, n) ?? r;
+    return T(o, e, n);
+  };
+}
+const w = i(), x = { t: w, locale: c }, m = h(null);
+function W({
+  translations: t,
+  locale: e,
+  timezone: r,
+  children: n
+}) {
+  const o = p(() => {
+    const u = e ?? c;
+    return { t: i(t, u), locale: u, timezone: r };
+  }, [t, e, r]);
+  return /* @__PURE__ */ f(m.Provider, { value: o, children: n });
+}
+function I() {
+  return C(m) ?? x;
+}
+function E() {
+  const { t } = I();
+  return /* @__PURE__ */ f(d, { children: t("helloWorld") });
+}
+export {
+  E as CohortsHelloWorld,
+  W as CohortsI18nProvider,
+  c as DEFAULT_LOCALE,
+  i as createTranslate,
+  w as defaultTranslate,
+  I as useCohortsI18n
+};

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+  "helloWorld": "Hello World"
+}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@instructure/platform-cohorts",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./locales/*": "./locales/*"
+  },
+  "files": [
+    "dist",
+    "locales"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "pack:tarball": "pnpm build && pnpm pack",
+    "test": "vitest run --coverage",
+    "test:watch": "vitest",
+    "type-check": "tsgo -p tsconfig.check.json"
+  },
+  "peerDependencies": {
+    "@instructure/platform-provider": "workspace:*",
+    "@instructure/ui-text": "^11.0.0",
+    "@instructure/ui-view": "^11.0.0",
+    "@tanstack/react-query": "^5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "devDependencies": {
+    "@instructure/platform-provider": "workspace:*",
+    "@instructure/platform-test-utils": "workspace:*",
+    "@instructure/ui-text": "11.7.4",
+    "@instructure/ui-view": "11.7.4",
+    "@storybook/react": "^10.0.8",
+    "@tanstack/react-query": "^5.59.15",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.0",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.2.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "jsdom": "^25.0.0",
+    "msw": "^2.0.0",
+    "typescript": "^5.3.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^4.0.0"
+  }
+}