@vimine/sdk 0.2.0 → 0.3.3

package/README.md

@@ -29,7 +29,7 @@ if (result) location.assign(result.returnTo || '/');
 // 3. usa l'API per conto del socio
 const me = await vimine.me.get();
 const membership = await vimine.membership.get();      // stato, verdetto, scadenza, token della tessera
-await vimine.membership.request({ accept_statuto: { version: 3 } });
+await vimine.membership.request({ accept_statuto: { version: 3 }, privacy_notice: { version: 2 } });
 await vimine.membership.acceptStatuto({ version: 3 });
 const card = await vimine.membership.card();           // { token: 'vmt_…', nbf, exp }
 await vimine.connections.revoke('vmc_altra_app');

package/dist/elements.d.ts

@@ -1,6 +1,173 @@
-import { Vimine, type VimineOptions } from './index.js';
+import { Vimine, type VimineOptions } from "./index.js";
+declare const STRINGS: {
+    it: {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    en: {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    "zh-Hans": {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    "zh-Hant": {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    fr: {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    es: {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    de: {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+    "pt-BR": {
+        signIn: string;
+        signOut: string;
+        loading: string;
+        notSignedIn: string;
+        noMembership: string;
+        notActive: string;
+        error: string;
+        noEvents: string;
+        free: string;
+        places: string;
+        register: string;
+        signInToRegister: string;
+        joinAndBook: string;
+        alreadyMember: string;
+        registered: string;
+        reserved: string;
+        details: string;
+        reason: Record<string, string>;
+    };
+};
+type Lang = keyof typeof STRINGS;
+/** The elements' language for a page's tag, or null when they do not speak it (`preview`: drafts included). */
+export declare const matchLang: (tag: string, preview?: boolean) => Lang | null;
 /** The client the elements use. Call once; pass your own instance to share it with the rest of the page. */
-export declare function defineVimineElements(options: VimineOptions | Vimine): Vimine;
+export declare function defineVimineElements(options: VimineOptions | Vimine, elements?: {
+    previewLanguages?: boolean;
+}): Vimine;
 /** `<vimine-sign-in scope="…" return-to="/area" label="…" handle-redirect>` — a sign-in / sign-out button. */
 export declare class VimineSignIn extends HTMLElement {
     private unsubscribe;
@@ -16,15 +183,59 @@ export declare class VimineCard extends HTMLElement {
     disconnectedCallback(): void;
     private render;
 }
-/** `<vimine-enroll slug="…" app-url="https://app.vimine.network" height="900">` — the hosted enrolment form. */
+/** The hosted enrolment page of an association, in a language: the frame's address, and where a hand-off lands. */
+/**
+ * How the hosted enrolment page looks inside the host site: its scheme, the accent of its buttons, links and the
+ * association's name, and the ground behind its cards (`transparent`: the host page shows through). The page reads them
+ * from its address — a framed page cannot see the host's CSS — and ignores anything that is not a colour or a keyword.
+ */
+export type EnrollAppearance = {
+    scheme?: "light" | "dark";
+    accent?: string;
+    background?: string;
+    font?: Typeface;
+};
+/** The faces the hosted page offers — served by Vimine itself — or `system`, the device's own. They set everything. */
+export declare const TYPEFACES: readonly ["system", "inter", "roboto", "open-sans", "montserrat", "nunito", "lora", "merriweather", "roboto-slab"];
+export type Typeface = (typeof TYPEFACES)[number];
+export declare const enrollUrl: (appUrl: string, slug: string, lang: string, appearance?: EnrollAppearance) => string;
+/**
+ * The same page, opened FROM an event: the person joins the association and asks for a place at the event in one go.
+ * The request carries the event; the place is confirmed, or held until the membership is active.
+ */
+export declare const eventEnrollUrl: (appUrl: string, slug: string, event: string, lang: string) => string;
+/**
+ * `<vimine-enroll slug="…" app-url="https://app.vimine.network" height="900" lang="en">` — the hosted enrolment form.
+ *
+ * Styled like the other elements, through CSS custom properties on the element or any ancestor:
+ *
+ *   vimine-enroll { --vimine-scheme: light; --vimine-accent: #1e3a5f; --vimine-background: transparent; }
+ *
+ * `--vimine-scheme` the page's scheme; `--vimine-accent` its buttons, links and the association's name (moved towards
+ * the page's ink when it would not read on its cards); `--vimine-background` the ground behind the cards;
+ * `--vimine-typeface` the face of the whole page, fields included — one of TYPEFACES, served by Vimine (a framed page
+ * cannot use the host's fonts). The frame is styled once, when the element connects.
+ *
+ * The form opens in the element's language (`lang` on the element or the page; Italian by default). Someone who already
+ * has a Vimine account need not fill it: the form offers *Continua su Vimine*, which opens the hosted page in a new
+ * tab — there their session is recognised and they join in one step (the association's statuto and privacy notice, and
+ * nothing they have already told Vimine). It is a hand-off and not a sign-in inside the frame because a browser keeps a
+ * framed page's session apart from the same site opened directly; the frame's sandbox lets that tab open as an ordinary
+ * page (`allow-popups-to-escape-sandbox`).
+ */
 export declare class VimineEnroll extends HTMLElement {
     connectedCallback(): void;
 }
 /**
  * `<vimine-events slug="…" filter="upcoming" limit="10" detail-url="/eventi/{slug}">` — the association's events:
  * the public ones for a visitor (no sign-in), every published one for a signed-in member, each with its registration
- * types (contribution, places left) and a register button (`registrations:write`) — or a sign-in button. Fires
- * `vimine-registration` `{ registration }` after a registration. `detail-url` (with `{slug}`) adds a details link.
+ * types (contribution, places left) and a register button (`registrations:write`). Fires `vimine-registration`
+ * `{ registration }` after a registration. `detail-url` (with `{slug}`) adds a details link.
+ *
+ * A VISITOR is offered a way in, not a bare sign-in: *Iscriviti all’associazione e prenota* opens the association's
+ * hosted enrolment page with the event (a new tab; `app-url` as on `<vimine-enroll>`) — they join and ask for the place
+ * in one go — and *Sono già socio: accedi* signs a member in here. The first is shown while the event has a registration
+ * that can be had and the association takes enrolment requests; otherwise the sign-in alone.
  */
 export declare class VimineEvents extends HTMLElement {
     private unsubscribe;
@@ -35,3 +246,4 @@ export declare class VimineEvents extends HTMLElement {
     private card;
     private typeRow;
 }
+export {};