@lssm/lib.feature-flags 0.0.0-canary-20251217062139 → 0.0.0-canary-20251217060834
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/contracts/index.js +1 -1
- package/dist/docs/feature-flags.docblock.js +1 -1
- package/dist/entities/index.js +1 -1
- package/dist/events.js +1 -1
- package/package.json +5 -5
- package/dist/contracts/dist/capabilities/openbanking.js +0 -1
- package/dist/contracts/dist/client/index.js +0 -1
- package/dist/contracts/dist/client/react/feature-render.js +0 -1
- package/dist/contracts/dist/client/react/form-render.js +0 -1
- package/dist/contracts/dist/client/react/index.js +0 -1
- package/dist/contracts/dist/contract-registry/index.js +0 -1
- package/dist/contracts/dist/contract-registry/schemas.js +0 -1
- package/dist/contracts/dist/docs/PUBLISHING.docblock.js +0 -76
- package/dist/contracts/dist/docs/accessibility_wcag_compliance_specs.docblock.js +0 -350
- package/dist/contracts/dist/docs/index.js +0 -1
- package/dist/contracts/dist/docs/presentations.js +0 -1
- package/dist/contracts/dist/docs/registry.js +0 -1
- package/dist/contracts/dist/docs/tech/PHASE_1_QUICKSTART.docblock.js +0 -383
- package/dist/contracts/dist/docs/tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js +0 -68
- package/dist/contracts/dist/docs/tech/PHASE_3_AUTO_EVOLUTION.docblock.js +0 -140
- package/dist/contracts/dist/docs/tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js +0 -86
- package/dist/contracts/dist/docs/tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/auth/better-auth-nextjs.docblock.js +0 -58
- package/dist/contracts/dist/docs/tech/contracts/openapi-export.docblock.js +0 -38
- package/dist/contracts/dist/docs/tech/lifecycle-stage-system.docblock.js +0 -213
- package/dist/contracts/dist/docs/tech/llm/llm-integration.docblock.js +0 -289
- package/dist/contracts/dist/docs/tech/mcp-endpoints.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/presentation-runtime.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/schema/README.docblock.js +0 -262
- package/dist/contracts/dist/docs/tech/studio/learning-events.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/studio/learning-journeys.docblock.js +0 -57
- package/dist/contracts/dist/docs/tech/studio/platform-admin-panel.docblock.js +0 -63
- package/dist/contracts/dist/docs/tech/studio/project-access-teams.docblock.js +0 -36
- package/dist/contracts/dist/docs/tech/studio/project-routing.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/studio/sandbox-unlogged.docblock.js +0 -20
- package/dist/contracts/dist/docs/tech/studio/team-invitations.docblock.js +0 -65
- package/dist/contracts/dist/docs/tech/studio/workspace-ops.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/studio/workspaces.docblock.js +0 -41
- package/dist/contracts/dist/docs/tech/telemetry-ingest.docblock.js +0 -122
- package/dist/contracts/dist/docs/tech/templates/runtime.docblock.js +0 -1
- package/dist/contracts/dist/docs/tech/vscode-extension.docblock.js +0 -68
- package/dist/contracts/dist/docs/tech/workflows/overview.docblock.js +0 -1
- package/dist/contracts/dist/events.js +0 -1
- package/dist/contracts/dist/experiments/evaluator.js +0 -1
- package/dist/contracts/dist/index.js +0 -1
- package/dist/contracts/dist/install.js +0 -1
- package/dist/contracts/dist/integrations/contracts.js +0 -1
- package/dist/contracts/dist/integrations/index.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/contracts/accounts.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/contracts/balances.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/contracts/index.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/contracts/transactions.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/models.js +0 -1
- package/dist/contracts/dist/integrations/openbanking/telemetry.js +0 -1
- package/dist/contracts/dist/integrations/providers/elevenlabs.js +0 -1
- package/dist/contracts/dist/integrations/providers/gcs-storage.js +0 -1
- package/dist/contracts/dist/integrations/providers/gmail.js +0 -1
- package/dist/contracts/dist/integrations/providers/google-calendar.js +0 -1
- package/dist/contracts/dist/integrations/providers/index.js +0 -1
- package/dist/contracts/dist/integrations/providers/mistral.js +0 -1
- package/dist/contracts/dist/integrations/providers/postmark.js +0 -1
- package/dist/contracts/dist/integrations/providers/powens.js +0 -1
- package/dist/contracts/dist/integrations/providers/qdrant.js +0 -1
- package/dist/contracts/dist/integrations/providers/registry.js +0 -1
- package/dist/contracts/dist/integrations/providers/stripe.js +0 -1
- package/dist/contracts/dist/integrations/providers/twilio-sms.js +0 -1
- package/dist/contracts/dist/jsonschema.js +0 -1
- package/dist/contracts/dist/knowledge/contracts.js +0 -1
- package/dist/contracts/dist/knowledge/index.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/email-threads.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/financial-docs.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/financial-overview.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/index.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/product-canon.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/support-faq.js +0 -1
- package/dist/contracts/dist/knowledge/spaces/uploaded-docs.js +0 -1
- package/dist/contracts/dist/llm/exporters.js +0 -1
- package/dist/contracts/dist/llm/index.js +0 -1
- package/dist/contracts/dist/llm/prompts.js +0 -1
- package/dist/contracts/dist/onboarding-base.js +0 -1
- package/dist/contracts/dist/openapi.js +0 -1
- package/dist/contracts/dist/ownership.js +0 -1
- package/dist/contracts/dist/presentations.js +0 -1
- package/dist/contracts/dist/presentations.v2.js +0 -1
- package/dist/contracts/dist/prompt.js +0 -1
- package/dist/contracts/dist/promptRegistry.js +0 -1
- package/dist/contracts/dist/regenerator/index.js +0 -1
- package/dist/contracts/dist/regenerator/service.js +0 -1
- package/dist/contracts/dist/registry.js +0 -1
- package/dist/contracts/dist/resources.js +0 -1
- package/dist/contracts/dist/schema/dist/EnumType.js +0 -1
- package/dist/contracts/dist/schema/dist/FieldType.js +0 -1
- package/dist/contracts/dist/schema/dist/ScalarTypeEnum.js +0 -1
- package/dist/contracts/dist/schema/dist/SchemaModel.js +0 -1
- package/dist/contracts/dist/schema/dist/entity/defineEntity.js +0 -1
- package/dist/contracts/dist/schema/dist/entity/index.js +0 -1
- package/dist/contracts/dist/schema/dist/entity/types.js +0 -1
- package/dist/contracts/dist/schema/dist/index.js +0 -1
- package/dist/contracts/dist/server/graphql-pothos.js +0 -1
- package/dist/contracts/dist/server/index.js +0 -1
- package/dist/contracts/dist/server/mcp/createMcpServer.js +0 -1
- package/dist/contracts/dist/server/mcp/registerPresentations.js +0 -1
- package/dist/contracts/dist/server/mcp/registerPrompts.js +0 -1
- package/dist/contracts/dist/server/mcp/registerResources.js +0 -1
- package/dist/contracts/dist/server/mcp/registerTools.js +0 -1
- package/dist/contracts/dist/server/provider-mcp.js +0 -1
- package/dist/contracts/dist/server/rest-elysia.js +0 -1
- package/dist/contracts/dist/server/rest-express.js +0 -1
- package/dist/contracts/dist/server/rest-generic.js +0 -1
- package/dist/contracts/dist/server/rest-next-app.js +0 -1
- package/dist/contracts/dist/server/rest-next-pages.js +0 -1
- package/dist/contracts/dist/spec.js +0 -1
- package/dist/contracts/dist/telemetry/index.js +0 -1
- package/dist/contracts/dist/telemetry/tracker.js +0 -1
- package/dist/contracts/dist/tests/index.js +0 -1
- package/dist/contracts/dist/tests/runner.js +0 -1
- package/dist/contracts/dist/workflow/index.js +0 -1
- package/dist/contracts/dist/workflow/runner.js +0 -1
- package/dist/schema/dist/EnumType.js +0 -1
- package/dist/schema/dist/FieldType.js +0 -1
- package/dist/schema/dist/ScalarTypeEnum.js +0 -1
- package/dist/schema/dist/SchemaModel.js +0 -1
- package/dist/schema/dist/entity/defineEntity.js +0 -1
- package/dist/schema/dist/entity/index.js +0 -1
- package/dist/schema/dist/entity/types.js +0 -1
- package/dist/schema/dist/index.js +0 -1
package/dist/contracts/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{l as e}from"../schema/dist/ScalarTypeEnum.js";import{n as t}from"../schema/dist/SchemaModel.js";import"../schema/dist/index.js";import{n,t as r}from"./dist/spec.js";import"./dist/index.js";const i=[`platform.feature-flags`],a=t({name:`FeatureFlag`,description:`Represents a feature flag`,fields:{id:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},status:{type:e.String_unsecure(),isOptional:!1},defaultValue:{type:e.Boolean(),isOptional:!1},variants:{type:e.JSON(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1},updatedAt:{type:e.DateTime(),isOptional:!1}}}),o=t({name:`TargetingRule`,description:`Represents a targeting rule`,fields:{id:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},priority:{type:e.Int_unsecure(),isOptional:!1},enabled:{type:e.Boolean(),isOptional:!1},attribute:{type:e.String_unsecure(),isOptional:!1},operator:{type:e.String_unsecure(),isOptional:!1},value:{type:e.JSON(),isOptional:!1},rolloutPercentage:{type:e.Int_unsecure(),isOptional:!0},serveValue:{type:e.Boolean(),isOptional:!0},serveVariant:{type:e.String_unsecure(),isOptional:!0}}}),s=t({name:`Experiment`,description:`Represents an experiment`,fields:{id:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},hypothesis:{type:e.String_unsecure(),isOptional:!0},flagId:{type:e.String_unsecure(),isOptional:!1},status:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},metrics:{type:e.JSON(),isOptional:!0},audiencePercentage:{type:e.Int_unsecure(),isOptional:!1},startedAt:{type:e.DateTime(),isOptional:!0},endedAt:{type:e.DateTime(),isOptional:!0},winningVariant:{type:e.String_unsecure(),isOptional:!0},results:{type:e.JSON(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1}}}),c=t({name:`EvaluationResult`,description:`Result of flag evaluation`,fields:{enabled:{type:e.Boolean(),isOptional:!1},variant:{type:e.String_unsecure(),isOptional:!0},reason:{type:e.String_unsecure(),isOptional:!1},ruleId:{type:e.String_unsecure(),isOptional:!0},experimentId:{type:e.String_unsecure(),isOptional:!0}}}),l=t({name:`CreateFlagInput`,description:`Input for creating a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},defaultValue:{type:e.Boolean(),isOptional:!0},variants:{type:e.JSON(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0}}}),u=t({name:`UpdateFlagInput`,description:`Input for updating a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},description:{type:e.String_unsecure(),isOptional:!0},defaultValue:{type:e.Boolean(),isOptional:!0},variants:{type:e.JSON(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0}}}),d=t({name:`DeleteFlagInput`,description:`Input for deleting a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1}}}),f=t({name:`ToggleFlagInput`,description:`Input for toggling a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},status:{type:e.String_unsecure(),isOptional:!1}}}),p=t({name:`GetFlagInput`,description:`Input for getting a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},orgId:{type:e.String_unsecure(),isOptional:!0}}}),m=t({name:`ListFlagsInput`,description:`Input for listing feature flags`,fields:{orgId:{type:e.String_unsecure(),isOptional:!0},status:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0},limit:{type:e.Int_unsecure(),isOptional:!0},offset:{type:e.Int_unsecure(),isOptional:!0}}}),h=t({name:`ListFlagsOutput`,description:`Output for listing feature flags`,fields:{flags:{type:a,isArray:!0,isOptional:!1},total:{type:e.Int_unsecure(),isOptional:!1}}}),g=t({name:`EvaluateFlagInput`,description:`Input for evaluating a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},context:{type:e.JSON(),isOptional:!1}}}),_=t({name:`CreateRuleInput`,description:`Input for creating a targeting rule`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},priority:{type:e.Int_unsecure(),isOptional:!0},attribute:{type:e.String_unsecure(),isOptional:!1},operator:{type:e.String_unsecure(),isOptional:!1},value:{type:e.JSON(),isOptional:!1},rolloutPercentage:{type:e.Int_unsecure(),isOptional:!0},serveValue:{type:e.Boolean(),isOptional:!0},serveVariant:{type:e.String_unsecure(),isOptional:!0}}}),v=t({name:`DeleteRuleInput`,description:`Input for deleting a targeting rule`,fields:{ruleId:{type:e.String_unsecure(),isOptional:!1}}}),y=t({name:`CreateExperimentInput`,description:`Input for creating an experiment`,fields:{key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},hypothesis:{type:e.String_unsecure(),isOptional:!0},flagId:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},metrics:{type:e.JSON(),isOptional:!0},audiencePercentage:{type:e.Int_unsecure(),isOptional:!0},scheduledStartAt:{type:e.DateTime(),isOptional:!0},scheduledEndAt:{type:e.DateTime(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0}}}),b=t({name:`StartExperimentInput`,description:`Input for starting an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1}}}),x=t({name:`StopExperimentInput`,description:`Input for stopping an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},reason:{type:e.String_unsecure(),isOptional:!1},winningVariant:{type:e.String_unsecure(),isOptional:!0}}}),S=t({name:`GetExperimentInput`,description:`Input for getting an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1}}}),C=t({name:`SuccessOutput`,description:`Generic success output`,fields:{success:{type:e.Boolean(),isOptional:!1}}}),w=r({meta:{name:`flag.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`create`],description:`Create a new feature flag.`,goal:`Define a new feature flag for toggling features.`,context:`Called when setting up a new feature flag.`},io:{input:l,output:a,errors:{KEY_ALREADY_EXISTS:{description:`Flag key already exists`,http:409,gqlCode:`FLAG_KEY_EXISTS`,when:`A flag with this key already exists`}}},policy:{auth:`admin`}}),T=r({meta:{name:`flag.update`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`update`],description:`Update an existing feature flag.`,goal:`Modify flag configuration.`,context:`Called when adjusting flag settings.`},io:{input:u,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`}}},policy:{auth:`admin`}}),E=r({meta:{name:`flag.delete`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`delete`],description:`Delete a feature flag.`,goal:`Remove a feature flag and all its rules.`,context:`Called when a flag is no longer needed.`},io:{input:d,output:C,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},FLAG_HAS_ACTIVE_EXPERIMENT:{description:`Flag has an active experiment`,http:409,gqlCode:`FLAG_HAS_ACTIVE_EXPERIMENT`,when:`Cannot delete flag with running experiment`}}},policy:{auth:`admin`}}),D=r({meta:{name:`flag.toggle`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`toggle`],description:`Toggle a feature flag status.`,goal:`Quickly enable or disable a feature.`,context:`Called when turning a feature on or off.`},io:{input:f,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},INVALID_STATUS:{description:`Invalid status value`,http:400,gqlCode:`INVALID_STATUS`,when:`Status must be OFF, ON, or GRADUAL`}}},policy:{auth:`admin`}}),O=n({meta:{name:`flag.get`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`get`],description:`Get a feature flag by key.`,goal:`Retrieve flag configuration.`,context:`Called to inspect flag details.`},io:{input:p,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag key is invalid`}}},policy:{auth:`user`}}),k=n({meta:{name:`flag.list`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`list`],description:`List all feature flags.`,goal:`View all configured flags.`,context:`Admin dashboard.`},io:{input:m,output:h},policy:{auth:`admin`}}),A=n({meta:{name:`flag.evaluate`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`evaluate`],description:`Evaluate a feature flag for a given context.`,goal:`Determine if a feature should be enabled.`,context:`Called at runtime to check feature availability.`},io:{input:g,output:c,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag key is invalid`}}},policy:{auth:`anonymous`}}),j=r({meta:{name:`flag.rule.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`rule`,`create`],description:`Create a targeting rule for a flag.`,goal:`Add conditional targeting to a flag.`,context:`Called when setting up targeting.`},io:{input:_,output:o,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},INVALID_OPERATOR:{description:`Invalid operator`,http:400,gqlCode:`INVALID_OPERATOR`,when:`Operator is not supported`}}},policy:{auth:`admin`}}),M=r({meta:{name:`flag.rule.delete`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`rule`,`delete`],description:`Delete a targeting rule.`,goal:`Remove a targeting rule from a flag.`,context:`Called when removing targeting conditions.`},io:{input:v,output:C,errors:{RULE_NOT_FOUND:{description:`Rule does not exist`,http:404,gqlCode:`RULE_NOT_FOUND`,when:`Rule ID is invalid`}}},policy:{auth:`admin`}}),N=r({meta:{name:`experiment.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`create`],description:`Create an A/B test experiment.`,goal:`Set up an experiment with variants.`,context:`Called when setting up A/B testing.`},io:{input:y,output:s,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},EXPERIMENT_KEY_EXISTS:{description:`Experiment key already exists`,http:409,gqlCode:`EXPERIMENT_KEY_EXISTS`,when:`An experiment with this key already exists`},INVALID_VARIANTS:{description:`Invalid variant configuration`,http:400,gqlCode:`INVALID_VARIANTS`,when:`Variant percentages must sum to 100`}}},policy:{auth:`admin`}}),P=r({meta:{name:`experiment.start`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`start`],description:`Start an experiment.`,goal:`Begin collecting data for an experiment.`,context:`Called when ready to run an A/B test.`},io:{input:b,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`},EXPERIMENT_ALREADY_RUNNING:{description:`Experiment is already running`,http:409,gqlCode:`EXPERIMENT_ALREADY_RUNNING`,when:`Cannot start an experiment that is already running`}}},policy:{auth:`admin`}}),F=r({meta:{name:`experiment.stop`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`stop`],description:`Stop an experiment.`,goal:`End an experiment and optionally declare a winner.`,context:`Called when concluding an A/B test.`},io:{input:x,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`},EXPERIMENT_NOT_RUNNING:{description:`Experiment is not running`,http:409,gqlCode:`EXPERIMENT_NOT_RUNNING`,when:`Cannot stop an experiment that is not running`}}},policy:{auth:`admin`}}),I=n({meta:{name:`experiment.get`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`get`],description:`Get experiment details.`,goal:`View experiment configuration and results.`,context:`Called to inspect experiment status.`},io:{input:S,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`}}},policy:{auth:`user`}});export{N as CreateExperimentContract,w as CreateFlagContract,j as CreateRuleContract,E as DeleteFlagContract,M as DeleteRuleContract,A as EvaluateFlagContract,c as EvaluationResultModel,s as ExperimentModel,a as FeatureFlagModel,I as GetExperimentContract,O as GetFlagContract,k as ListFlagsContract,P as StartExperimentContract,F as StopExperimentContract,o as TargetingRuleModel,D as ToggleFlagContract,T as UpdateFlagContract};
|
|
1
|
+
import{ScalarTypeEnum as e,defineSchemaModel as t}from"@lssm/lib.schema";import{defineCommand as n,defineQuery as r}from"@lssm/lib.contracts";const i=[`platform.feature-flags`],a=t({name:`FeatureFlag`,description:`Represents a feature flag`,fields:{id:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},status:{type:e.String_unsecure(),isOptional:!1},defaultValue:{type:e.Boolean(),isOptional:!1},variants:{type:e.JSON(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1},updatedAt:{type:e.DateTime(),isOptional:!1}}}),o=t({name:`TargetingRule`,description:`Represents a targeting rule`,fields:{id:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},priority:{type:e.Int_unsecure(),isOptional:!1},enabled:{type:e.Boolean(),isOptional:!1},attribute:{type:e.String_unsecure(),isOptional:!1},operator:{type:e.String_unsecure(),isOptional:!1},value:{type:e.JSON(),isOptional:!1},rolloutPercentage:{type:e.Int_unsecure(),isOptional:!0},serveValue:{type:e.Boolean(),isOptional:!0},serveVariant:{type:e.String_unsecure(),isOptional:!0}}}),s=t({name:`Experiment`,description:`Represents an experiment`,fields:{id:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},hypothesis:{type:e.String_unsecure(),isOptional:!0},flagId:{type:e.String_unsecure(),isOptional:!1},status:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},metrics:{type:e.JSON(),isOptional:!0},audiencePercentage:{type:e.Int_unsecure(),isOptional:!1},startedAt:{type:e.DateTime(),isOptional:!0},endedAt:{type:e.DateTime(),isOptional:!0},winningVariant:{type:e.String_unsecure(),isOptional:!0},results:{type:e.JSON(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1}}}),c=t({name:`EvaluationResult`,description:`Result of flag evaluation`,fields:{enabled:{type:e.Boolean(),isOptional:!1},variant:{type:e.String_unsecure(),isOptional:!0},reason:{type:e.String_unsecure(),isOptional:!1},ruleId:{type:e.String_unsecure(),isOptional:!0},experimentId:{type:e.String_unsecure(),isOptional:!0}}}),l=t({name:`CreateFlagInput`,description:`Input for creating a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},defaultValue:{type:e.Boolean(),isOptional:!0},variants:{type:e.JSON(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0}}}),u=t({name:`UpdateFlagInput`,description:`Input for updating a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},description:{type:e.String_unsecure(),isOptional:!0},defaultValue:{type:e.Boolean(),isOptional:!0},variants:{type:e.JSON(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0}}}),d=t({name:`DeleteFlagInput`,description:`Input for deleting a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1}}}),f=t({name:`ToggleFlagInput`,description:`Input for toggling a feature flag`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},status:{type:e.String_unsecure(),isOptional:!1}}}),p=t({name:`GetFlagInput`,description:`Input for getting a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},orgId:{type:e.String_unsecure(),isOptional:!0}}}),m=t({name:`ListFlagsInput`,description:`Input for listing feature flags`,fields:{orgId:{type:e.String_unsecure(),isOptional:!0},status:{type:e.String_unsecure(),isOptional:!0},tags:{type:e.JSON(),isOptional:!0},limit:{type:e.Int_unsecure(),isOptional:!0},offset:{type:e.Int_unsecure(),isOptional:!0}}}),h=t({name:`ListFlagsOutput`,description:`Output for listing feature flags`,fields:{flags:{type:a,isArray:!0,isOptional:!1},total:{type:e.Int_unsecure(),isOptional:!1}}}),g=t({name:`EvaluateFlagInput`,description:`Input for evaluating a feature flag`,fields:{key:{type:e.String_unsecure(),isOptional:!1},context:{type:e.JSON(),isOptional:!1}}}),_=t({name:`CreateRuleInput`,description:`Input for creating a targeting rule`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!0},priority:{type:e.Int_unsecure(),isOptional:!0},attribute:{type:e.String_unsecure(),isOptional:!1},operator:{type:e.String_unsecure(),isOptional:!1},value:{type:e.JSON(),isOptional:!1},rolloutPercentage:{type:e.Int_unsecure(),isOptional:!0},serveValue:{type:e.Boolean(),isOptional:!0},serveVariant:{type:e.String_unsecure(),isOptional:!0}}}),v=t({name:`DeleteRuleInput`,description:`Input for deleting a targeting rule`,fields:{ruleId:{type:e.String_unsecure(),isOptional:!1}}}),y=t({name:`CreateExperimentInput`,description:`Input for creating an experiment`,fields:{key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},description:{type:e.String_unsecure(),isOptional:!0},hypothesis:{type:e.String_unsecure(),isOptional:!0},flagId:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},metrics:{type:e.JSON(),isOptional:!0},audiencePercentage:{type:e.Int_unsecure(),isOptional:!0},scheduledStartAt:{type:e.DateTime(),isOptional:!0},scheduledEndAt:{type:e.DateTime(),isOptional:!0},orgId:{type:e.String_unsecure(),isOptional:!0}}}),b=t({name:`StartExperimentInput`,description:`Input for starting an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1}}}),x=t({name:`StopExperimentInput`,description:`Input for stopping an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},reason:{type:e.String_unsecure(),isOptional:!1},winningVariant:{type:e.String_unsecure(),isOptional:!0}}}),S=t({name:`GetExperimentInput`,description:`Input for getting an experiment`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1}}}),C=t({name:`SuccessOutput`,description:`Generic success output`,fields:{success:{type:e.Boolean(),isOptional:!1}}}),w=n({meta:{name:`flag.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`create`],description:`Create a new feature flag.`,goal:`Define a new feature flag for toggling features.`,context:`Called when setting up a new feature flag.`},io:{input:l,output:a,errors:{KEY_ALREADY_EXISTS:{description:`Flag key already exists`,http:409,gqlCode:`FLAG_KEY_EXISTS`,when:`A flag with this key already exists`}}},policy:{auth:`admin`}}),T=n({meta:{name:`flag.update`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`update`],description:`Update an existing feature flag.`,goal:`Modify flag configuration.`,context:`Called when adjusting flag settings.`},io:{input:u,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`}}},policy:{auth:`admin`}}),E=n({meta:{name:`flag.delete`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`delete`],description:`Delete a feature flag.`,goal:`Remove a feature flag and all its rules.`,context:`Called when a flag is no longer needed.`},io:{input:d,output:C,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},FLAG_HAS_ACTIVE_EXPERIMENT:{description:`Flag has an active experiment`,http:409,gqlCode:`FLAG_HAS_ACTIVE_EXPERIMENT`,when:`Cannot delete flag with running experiment`}}},policy:{auth:`admin`}}),D=n({meta:{name:`flag.toggle`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`toggle`],description:`Toggle a feature flag status.`,goal:`Quickly enable or disable a feature.`,context:`Called when turning a feature on or off.`},io:{input:f,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},INVALID_STATUS:{description:`Invalid status value`,http:400,gqlCode:`INVALID_STATUS`,when:`Status must be OFF, ON, or GRADUAL`}}},policy:{auth:`admin`}}),O=r({meta:{name:`flag.get`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`get`],description:`Get a feature flag by key.`,goal:`Retrieve flag configuration.`,context:`Called to inspect flag details.`},io:{input:p,output:a,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag key is invalid`}}},policy:{auth:`user`}}),k=r({meta:{name:`flag.list`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`list`],description:`List all feature flags.`,goal:`View all configured flags.`,context:`Admin dashboard.`},io:{input:m,output:h},policy:{auth:`admin`}}),A=r({meta:{name:`flag.evaluate`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`evaluate`],description:`Evaluate a feature flag for a given context.`,goal:`Determine if a feature should be enabled.`,context:`Called at runtime to check feature availability.`},io:{input:g,output:c,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag key is invalid`}}},policy:{auth:`anonymous`}}),j=n({meta:{name:`flag.rule.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`rule`,`create`],description:`Create a targeting rule for a flag.`,goal:`Add conditional targeting to a flag.`,context:`Called when setting up targeting.`},io:{input:_,output:o,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},INVALID_OPERATOR:{description:`Invalid operator`,http:400,gqlCode:`INVALID_OPERATOR`,when:`Operator is not supported`}}},policy:{auth:`admin`}}),M=n({meta:{name:`flag.rule.delete`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`rule`,`delete`],description:`Delete a targeting rule.`,goal:`Remove a targeting rule from a flag.`,context:`Called when removing targeting conditions.`},io:{input:v,output:C,errors:{RULE_NOT_FOUND:{description:`Rule does not exist`,http:404,gqlCode:`RULE_NOT_FOUND`,when:`Rule ID is invalid`}}},policy:{auth:`admin`}}),N=n({meta:{name:`experiment.create`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`create`],description:`Create an A/B test experiment.`,goal:`Set up an experiment with variants.`,context:`Called when setting up A/B testing.`},io:{input:y,output:s,errors:{FLAG_NOT_FOUND:{description:`Flag does not exist`,http:404,gqlCode:`FLAG_NOT_FOUND`,when:`Flag ID is invalid`},EXPERIMENT_KEY_EXISTS:{description:`Experiment key already exists`,http:409,gqlCode:`EXPERIMENT_KEY_EXISTS`,when:`An experiment with this key already exists`},INVALID_VARIANTS:{description:`Invalid variant configuration`,http:400,gqlCode:`INVALID_VARIANTS`,when:`Variant percentages must sum to 100`}}},policy:{auth:`admin`}}),P=n({meta:{name:`experiment.start`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`start`],description:`Start an experiment.`,goal:`Begin collecting data for an experiment.`,context:`Called when ready to run an A/B test.`},io:{input:b,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`},EXPERIMENT_ALREADY_RUNNING:{description:`Experiment is already running`,http:409,gqlCode:`EXPERIMENT_ALREADY_RUNNING`,when:`Cannot start an experiment that is already running`}}},policy:{auth:`admin`}}),F=n({meta:{name:`experiment.stop`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`stop`],description:`Stop an experiment.`,goal:`End an experiment and optionally declare a winner.`,context:`Called when concluding an A/B test.`},io:{input:x,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`},EXPERIMENT_NOT_RUNNING:{description:`Experiment is not running`,http:409,gqlCode:`EXPERIMENT_NOT_RUNNING`,when:`Cannot stop an experiment that is not running`}}},policy:{auth:`admin`}}),I=r({meta:{name:`experiment.get`,version:1,stability:`stable`,owners:[...i],tags:[`feature-flags`,`experiment`,`get`],description:`Get experiment details.`,goal:`View experiment configuration and results.`,context:`Called to inspect experiment status.`},io:{input:S,output:s,errors:{EXPERIMENT_NOT_FOUND:{description:`Experiment does not exist`,http:404,gqlCode:`EXPERIMENT_NOT_FOUND`,when:`Experiment ID is invalid`}}},policy:{auth:`user`}});export{N as CreateExperimentContract,w as CreateFlagContract,j as CreateRuleContract,E as DeleteFlagContract,M as DeleteRuleContract,A as EvaluateFlagContract,c as EvaluationResultModel,s as ExperimentModel,a as FeatureFlagModel,I as GetExperimentContract,O as GetFlagContract,k as ListFlagsContract,P as StartExperimentContract,F as StopExperimentContract,o as TargetingRuleModel,D as ToggleFlagContract,T as UpdateFlagContract};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{registerDocBlocks as e}from"@lssm/lib.contracts/docs";e([{id:`docs.feature-flags.overview`,title:`Feature Flags & Experiments`,summary:`Reusable, spec-first feature flag and experiment module with targeting, gradual rollout, multivariate variants, and evaluation logging.`,kind:`reference`,visibility:`public`,route:`/docs/feature-flags/overview`,tags:[`feature-flags`,`experiments`,`progressive-delivery`],body:`## What this module provides
|
|
2
2
|
|
|
3
3
|
- **Entities**: FeatureFlag, FlagTargetingRule, Experiment, ExperimentAssignment, FlagEvaluation.
|
|
4
4
|
- **Contracts**: create/update/delete/toggle/list/get flags; create/delete rules; evaluate flags; create/start/stop/get experiments.
|
package/dist/entities/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{defineEntity as e,defineEntityEnum as t,field as n,index as r}from"@lssm/lib.schema";const i=t({name:`FlagStatus`,values:[`OFF`,`ON`,`GRADUAL`],schema:`lssm_feature_flags`,description:`Status of a feature flag.`}),a=t({name:`RuleOperator`,values:[`EQ`,`NEQ`,`IN`,`NIN`,`CONTAINS`,`NOT_CONTAINS`,`GT`,`GTE`,`LT`,`LTE`,`PERCENTAGE`],schema:`lssm_feature_flags`,description:`Operator for targeting rule conditions.`}),o=t({name:`ExperimentStatus`,values:[`DRAFT`,`RUNNING`,`PAUSED`,`COMPLETED`,`CANCELLED`],schema:`lssm_feature_flags`,description:`Status of an experiment.`}),s=e({name:`FeatureFlag`,description:`A feature flag for controlling feature availability.`,schema:`lssm_feature_flags`,map:`feature_flag`,fields:{id:n.id({description:`Unique flag identifier`}),key:n.string({isUnique:!0,description:`Flag key (e.g., new_dashboard)`}),name:n.string({description:`Human-readable name`}),description:n.string({isOptional:!0,description:`Description of the flag`}),status:n.enum(`FlagStatus`,{default:`OFF`,description:`Flag status`}),defaultValue:n.boolean({default:!1,description:`Default value when no rules match`}),variants:n.json({isOptional:!0,description:`Variant definitions for multivariate flags`}),orgId:n.string({isOptional:!0,description:`Organization scope (null = global)`}),tags:n.json({isOptional:!0,description:`Tags for categorization`}),metadata:n.json({isOptional:!0,description:`Additional metadata`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),targetingRules:n.hasMany(`FlagTargetingRule`),experiments:n.hasMany(`Experiment`),evaluations:n.hasMany(`FlagEvaluation`)},indexes:[r.on([`orgId`,`key`]),r.on([`status`])],enums:[i]}),c=e({name:`FlagTargetingRule`,description:`A targeting rule for conditional flag evaluation.`,schema:`lssm_feature_flags`,map:`flag_targeting_rule`,fields:{id:n.id({description:`Unique rule identifier`}),flagId:n.foreignKey({description:`Parent feature flag`}),name:n.string({isOptional:!0,description:`Rule name for debugging`}),priority:n.int({default:0,description:`Rule priority (lower = higher priority)`}),enabled:n.boolean({default:!0,description:`Whether rule is active`}),attribute:n.string({description:`Target attribute (userId, orgId, plan, segment, etc.)`}),operator:n.enum(`RuleOperator`,{description:`Comparison operator`}),value:n.json({description:`Target value(s)`}),rolloutPercentage:n.int({isOptional:!0,description:`Percentage for gradual rollout (0-100)`}),serveValue:n.boolean({isOptional:!0,description:`Boolean value to serve`}),serveVariant:n.string({isOptional:!0,description:`Variant key to serve (for multivariate)`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),flag:n.belongsTo(`FeatureFlag`,[`flagId`],[`id`],{onDelete:`Cascade`})},indexes:[r.on([`flagId`,`priority`]),r.on([`attribute`])],enums:[a]}),l=e({name:`Experiment`,description:`An A/B test experiment.`,schema:`lssm_feature_flags`,map:`experiment`,fields:{id:n.id({description:`Unique experiment identifier`}),key:n.string({isUnique:!0,description:`Experiment key`}),name:n.string({description:`Human-readable name`}),description:n.string({isOptional:!0,description:`Experiment description`}),hypothesis:n.string({isOptional:!0,description:`Experiment hypothesis`}),flagId:n.foreignKey({description:`Associated feature flag`}),status:n.enum(`ExperimentStatus`,{default:`DRAFT`,description:`Experiment status`}),variants:n.json({description:`Variant definitions with split ratios`}),metrics:n.json({isOptional:!0,description:`Metrics to track`}),audiencePercentage:n.int({default:100,description:`Percentage of audience to include`}),audienceFilter:n.json({isOptional:!0,description:`Audience filter criteria`}),scheduledStartAt:n.dateTime({isOptional:!0,description:`Scheduled start time`}),scheduledEndAt:n.dateTime({isOptional:!0,description:`Scheduled end time`}),startedAt:n.dateTime({isOptional:!0,description:`Actual start time`}),endedAt:n.dateTime({isOptional:!0,description:`Actual end time`}),winningVariant:n.string({isOptional:!0,description:`Declared winning variant`}),results:n.json({isOptional:!0,description:`Experiment results summary`}),orgId:n.string({isOptional:!0,description:`Organization scope`}),createdAt:n.createdAt(),updatedAt:n.updatedAt(),flag:n.belongsTo(`FeatureFlag`,[`flagId`],[`id`],{onDelete:`Cascade`}),assignments:n.hasMany(`ExperimentAssignment`)},indexes:[r.on([`status`]),r.on([`orgId`,`status`]),r.on([`flagId`])],enums:[o]}),u=e({name:`ExperimentAssignment`,description:`Tracks experiment variant assignments.`,schema:`lssm_feature_flags`,map:`experiment_assignment`,fields:{id:n.id({description:`Unique assignment identifier`}),experimentId:n.foreignKey({description:`Parent experiment`}),subjectType:n.string({description:`Subject type (user, org, session)`}),subjectId:n.string({description:`Subject identifier`}),variant:n.string({description:`Assigned variant key`}),bucket:n.int({description:`Hash bucket (0-99)`}),context:n.json({isOptional:!0,description:`Context at assignment time`}),assignedAt:n.dateTime({description:`Assignment timestamp`}),experiment:n.belongsTo(`Experiment`,[`experimentId`],[`id`],{onDelete:`Cascade`})},indexes:[r.unique([`experimentId`,`subjectType`,`subjectId`],{name:`experiment_assignment_unique`}),r.on([`subjectType`,`subjectId`])]}),d=e({name:`FlagEvaluation`,description:`Log of flag evaluations for debugging and analytics.`,schema:`lssm_feature_flags`,map:`flag_evaluation`,fields:{id:n.id({description:`Unique evaluation identifier`}),flagId:n.foreignKey({description:`Evaluated flag`}),flagKey:n.string({description:`Flag key (denormalized for queries)`}),subjectType:n.string({description:`Subject type (user, org, anonymous)`}),subjectId:n.string({description:`Subject identifier`}),result:n.boolean({description:`Evaluation result`}),variant:n.string({isOptional:!0,description:`Served variant (for multivariate)`}),matchedRuleId:n.string({isOptional:!0,description:`Rule that matched (if any)`}),reason:n.string({description:`Evaluation reason (default, rule, experiment, etc.)`}),context:n.json({isOptional:!0,description:`Evaluation context`}),evaluatedAt:n.dateTime({description:`Evaluation timestamp`}),flag:n.belongsTo(`FeatureFlag`,[`flagId`],[`id`],{onDelete:`Cascade`})},indexes:[r.on([`flagKey`,`evaluatedAt`]),r.on([`subjectType`,`subjectId`,`evaluatedAt`]),r.on([`flagId`,`evaluatedAt`])]}),f=[s,c,l,u,d],p={moduleId:`@lssm/lib.feature-flags`,entities:f,enums:[i,a,o]};export{u as ExperimentAssignmentEntity,l as ExperimentEntity,o as ExperimentStatusEnum,s as FeatureFlagEntity,d as FlagEvaluationEntity,i as FlagStatusEnum,c as FlagTargetingRuleEntity,a as RuleOperatorEnum,f as featureFlagEntities,p as featureFlagsSchemaContribution};
|
package/dist/events.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{
|
|
1
|
+
import{ScalarTypeEnum as e,defineSchemaModel as t}from"@lssm/lib.schema";import{defineEvent as n}from"@lssm/lib.contracts";const r=t({name:`FlagCreatedEventPayload`,description:`Payload when a feature flag is created`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},status:{type:e.String_unsecure(),isOptional:!1},orgId:{type:e.String_unsecure(),isOptional:!0},createdBy:{type:e.String_unsecure(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1}}}),i=t({name:`FlagUpdatedEventPayload`,description:`Payload when a feature flag is updated`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},changes:{type:e.JSON(),isOptional:!1},updatedBy:{type:e.String_unsecure(),isOptional:!0},updatedAt:{type:e.DateTime(),isOptional:!1}}}),a=t({name:`FlagDeletedEventPayload`,description:`Payload when a feature flag is deleted`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},deletedBy:{type:e.String_unsecure(),isOptional:!0},deletedAt:{type:e.DateTime(),isOptional:!1}}}),o=t({name:`FlagToggledEventPayload`,description:`Payload when a feature flag status is toggled`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},previousStatus:{type:e.String_unsecure(),isOptional:!1},newStatus:{type:e.String_unsecure(),isOptional:!1},toggledBy:{type:e.String_unsecure(),isOptional:!0},toggledAt:{type:e.DateTime(),isOptional:!1}}}),s=t({name:`RuleCreatedEventPayload`,description:`Payload when a targeting rule is created`,fields:{ruleId:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},flagKey:{type:e.String_unsecure(),isOptional:!1},attribute:{type:e.String_unsecure(),isOptional:!1},operator:{type:e.String_unsecure(),isOptional:!1},createdAt:{type:e.DateTime(),isOptional:!1}}}),c=t({name:`RuleDeletedEventPayload`,description:`Payload when a targeting rule is deleted`,fields:{ruleId:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},flagKey:{type:e.String_unsecure(),isOptional:!1},deletedAt:{type:e.DateTime(),isOptional:!1}}}),l=t({name:`ExperimentCreatedEventPayload`,description:`Payload when an experiment is created`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},name:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},createdBy:{type:e.String_unsecure(),isOptional:!0},createdAt:{type:e.DateTime(),isOptional:!1}}}),u=t({name:`ExperimentStartedEventPayload`,description:`Payload when an experiment starts`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},flagId:{type:e.String_unsecure(),isOptional:!1},variants:{type:e.JSON(),isOptional:!1},audiencePercentage:{type:e.Int_unsecure(),isOptional:!1},startedBy:{type:e.String_unsecure(),isOptional:!0},startedAt:{type:e.DateTime(),isOptional:!1}}}),d=t({name:`ExperimentStoppedEventPayload`,description:`Payload when an experiment stops`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},key:{type:e.String_unsecure(),isOptional:!1},reason:{type:e.String_unsecure(),isOptional:!1},winningVariant:{type:e.String_unsecure(),isOptional:!0},stoppedBy:{type:e.String_unsecure(),isOptional:!0},stoppedAt:{type:e.DateTime(),isOptional:!1}}}),f=t({name:`FlagEvaluatedEventPayload`,description:`Payload when a flag is evaluated (for analytics)`,fields:{flagId:{type:e.String_unsecure(),isOptional:!1},flagKey:{type:e.String_unsecure(),isOptional:!1},subjectType:{type:e.String_unsecure(),isOptional:!1},subjectId:{type:e.String_unsecure(),isOptional:!1},result:{type:e.Boolean(),isOptional:!1},variant:{type:e.String_unsecure(),isOptional:!0},reason:{type:e.String_unsecure(),isOptional:!1},evaluatedAt:{type:e.DateTime(),isOptional:!1}}}),p=t({name:`VariantAssignedEventPayload`,description:`Payload when a subject is assigned to an experiment variant`,fields:{experimentId:{type:e.String_unsecure(),isOptional:!1},experimentKey:{type:e.String_unsecure(),isOptional:!1},subjectType:{type:e.String_unsecure(),isOptional:!1},subjectId:{type:e.String_unsecure(),isOptional:!1},variant:{type:e.String_unsecure(),isOptional:!1},bucket:{type:e.Int_unsecure(),isOptional:!1},assignedAt:{type:e.DateTime(),isOptional:!1}}}),m=n({name:`flag.created`,version:1,description:`A feature flag has been created.`,payload:r}),h=n({name:`flag.updated`,version:1,description:`A feature flag has been updated.`,payload:i}),g=n({name:`flag.deleted`,version:1,description:`A feature flag has been deleted.`,payload:a}),_=n({name:`flag.toggled`,version:1,description:`A feature flag status has been toggled.`,payload:o}),v=n({name:`flag.rule_created`,version:1,description:`A targeting rule has been created.`,payload:s}),y=n({name:`flag.rule_deleted`,version:1,description:`A targeting rule has been deleted.`,payload:c}),b=n({name:`experiment.created`,version:1,description:`An experiment has been created.`,payload:l}),x=n({name:`experiment.started`,version:1,description:`An experiment has started.`,payload:u}),S=n({name:`experiment.stopped`,version:1,description:`An experiment has stopped.`,payload:d}),C=n({name:`flag.evaluated`,version:1,description:`A feature flag has been evaluated.`,payload:f}),w=n({name:`experiment.variant_assigned`,version:1,description:`A subject has been assigned to an experiment variant.`,payload:p}),T={FlagCreatedEvent:m,FlagUpdatedEvent:h,FlagDeletedEvent:g,FlagToggledEvent:_,RuleCreatedEvent:v,RuleDeletedEvent:y,ExperimentCreatedEvent:b,ExperimentStartedEvent:x,ExperimentStoppedEvent:S,FlagEvaluatedEvent:C,VariantAssignedEvent:w};export{b as ExperimentCreatedEvent,x as ExperimentStartedEvent,S as ExperimentStoppedEvent,T as FeatureFlagEvents,m as FlagCreatedEvent,g as FlagDeletedEvent,C as FlagEvaluatedEvent,_ as FlagToggledEvent,h as FlagUpdatedEvent,v as RuleCreatedEvent,y as RuleDeletedEvent,w as VariantAssignedEvent};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lssm/lib.feature-flags",
|
|
3
|
-
"version": "0.0.0-canary-
|
|
3
|
+
"version": "0.0.0-canary-20251217060834",
|
|
4
4
|
"description": "Feature flags and experiments module for ContractSpec applications",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"types": "./dist/index.d.ts",
|
|
@@ -18,13 +18,13 @@
|
|
|
18
18
|
"lint:check": "eslint src"
|
|
19
19
|
},
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@lssm/lib.schema": "0.0.0-canary-
|
|
22
|
-
"@lssm/lib.contracts": "0.0.0-canary-
|
|
21
|
+
"@lssm/lib.schema": "0.0.0-canary-20251217060834",
|
|
22
|
+
"@lssm/lib.contracts": "0.0.0-canary-20251217060834",
|
|
23
23
|
"zod": "^4.1.13"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
"@lssm/tool.typescript": "0.0.0-canary-
|
|
27
|
-
"@lssm/tool.tsdown": "0.0.0-canary-
|
|
26
|
+
"@lssm/tool.typescript": "0.0.0-canary-20251217060834",
|
|
27
|
+
"@lssm/tool.tsdown": "0.0.0-canary-20251217060834",
|
|
28
28
|
"typescript": "^5.9.3"
|
|
29
29
|
},
|
|
30
30
|
"exports": {
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{e}from"../ownership.js";const t=[`platform.finance`],n=[`open-banking`,`finance`];[...t],[...n],e.Experimental,[...t],[...n],e.Experimental,[...t],[...n],e.Experimental;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use client";import"./react/feature-render.js";import"./react/form-render.js";import"./react/index.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import"../../presentations.v2.js";import"react";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import"react";import"react-hook-form";import"@hookform/resolvers/zod";import"react/jsx-runtime";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
"use client";import"./feature-render.js";import"./form-render.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{i as e,n as t,r as n}from"./schemas.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{e}from"../ownership.js";import t from"zod";const n=t.enum([`contractspec:operation`,`contractspec:event`,`contractspec:presentation`,`contractspec:form`,`contractspec:feature`,`contractspec:workflow`,`contractspec:template`,`contractspec:integration`,`contractspec:data-view`,`contractspec:migration`,`contractspec:telemetry`,`contractspec:experiment`,`contractspec:app-config`,`contractspec:knowledge`]),r=t.object({path:t.string().min(1),type:t.string().min(1),content:t.string().optional()}),i=t.object({name:t.string().min(1),type:n,version:t.number().int().nonnegative(),title:t.string().min(1),description:t.string().min(1),meta:t.object({stability:t.enum([e.Idea,e.InCreation,e.Experimental,e.Beta,e.Stable,e.Deprecated]),owners:t.array(t.string().min(1)).default([]),tags:t.array(t.string().min(1)).default([])}),dependencies:t.array(t.string().min(1)).optional(),registryDependencies:t.array(t.string().min(1)).optional(),files:t.array(r).min(1),schema:t.object({input:t.unknown().optional(),output:t.unknown().optional()}).optional()});t.object({$schema:t.string().min(1).optional(),name:t.string().min(1),homepage:t.string().min(1).optional(),items:t.array(i)});export{i,n,r};
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
import{a as e}from"./registry.js";e([{id:`docs.PUBLISHING`,title:`Publishing ContractSpec Libraries`,summary:`This guide describes how we release the ContractSpec libraries to npm. We use a dual-track release system: **Stable** (manual) and **Canary** (automatic).`,kind:`reference`,visibility:`public`,route:`/docs/PUBLISHING`,tags:[`PUBLISHING`],body:`# Publishing ContractSpec Libraries
|
|
2
|
-
|
|
3
|
-
This guide describes how we release the ContractSpec libraries to npm. We use a dual-track release system: **Stable** (manual) and **Canary** (automatic).
|
|
4
|
-
|
|
5
|
-
## Release Tracks
|
|
6
|
-
|
|
7
|
-
| Track | Branch | npm Tag | Frequency | Versioning | Use Case |
|
|
8
|
-
|-------|--------|---------|-----------|------------|----------|
|
|
9
|
-
| **Stable** | \`release\` | \`latest\` | Manual | SemVer (e.g., \`1.7.4\`) | Production, external users |
|
|
10
|
-
| **Canary** | \`main\` | \`canary\` | Every Push | Snapshot (e.g., \`1.7.4-canary...\`) | Dev, internal testing |
|
|
11
|
-
|
|
12
|
-
## Prerequisites
|
|
13
|
-
|
|
14
|
-
- ✅ \`NPM_TOKEN\` secret is configured in GitHub (owner or automation token with _publish_ scope).
|
|
15
|
-
- ✅ \`GITHUB_TOKEN\` (built-in) has permissions to create PRs (enabled by default in new repos).
|
|
16
|
-
- ✅ For stable releases: \`release\` branch exists and is protected.
|
|
17
|
-
|
|
18
|
-
## Canary Workflow (Automatic)
|
|
19
|
-
|
|
20
|
-
Every commit pushed to \`main\` triggers the \`.github/workflows/publish-canary.yml\` workflow.
|
|
21
|
-
|
|
22
|
-
1. **Trigger**: Push to \`main\`.
|
|
23
|
-
2. **Versioning**: Runs \`changeset version --snapshot canary\` to generate a temporary snapshot version.
|
|
24
|
-
3. **Publish**: Packages are published to npm with the \`canary\` tag using \`changeset publish --tag canary\`.
|
|
25
|
-
|
|
26
|
-
### Consuming Canary Builds
|
|
27
|
-
|
|
28
|
-
To install the latest bleeding-edge version:
|
|
29
|
-
|
|
30
|
-
\`\`\`bash
|
|
31
|
-
npm install @lssm/lib.contracts@canary
|
|
32
|
-
# or
|
|
33
|
-
bun add @lssm/lib.contracts@canary
|
|
34
|
-
\`\`\`
|
|
35
|
-
|
|
36
|
-
## Stable Release Workflow (Manual)
|
|
37
|
-
|
|
38
|
-
Stable releases are managed via the \`release\` branch using the standard [Changesets Action](https://github.com/changesets/action).
|
|
39
|
-
|
|
40
|
-
1. **Develop on \`main\`**: Create features and fixes.
|
|
41
|
-
2. **Add Changesets**: Run \`bun changeset\` to document changes and impact (major/minor/patch).
|
|
42
|
-
3. **Merge to \`release\`**: When ready to ship, open a PR from \`main\` to \`release\` or merge manually.
|
|
43
|
-
4. **"Version Packages" PR**:
|
|
44
|
-
- The GitHub Action detects new changesets and automatically creates a Pull Request titled **"Version Packages"**.
|
|
45
|
-
- This PR contains the version bumps and updated \`CHANGELOG.md\` files.
|
|
46
|
-
5. **Merge & Publish**:
|
|
47
|
-
- Review and merge the "Version Packages" PR.
|
|
48
|
-
- The Action runs again, detects the versions have been bumped, builds the libraries, and publishes them to npm with the \`latest\` tag.
|
|
49
|
-
|
|
50
|
-
### Publishing Steps
|
|
51
|
-
|
|
52
|
-
1. Ensure all changesets are present on \`main\`.
|
|
53
|
-
2. Merge \`main\` into \`release\`:
|
|
54
|
-
\`\`\`bash
|
|
55
|
-
git checkout release
|
|
56
|
-
git pull origin release
|
|
57
|
-
git merge main
|
|
58
|
-
git push origin release
|
|
59
|
-
\`\`\`
|
|
60
|
-
3. Go to GitHub Pull Requests. You will see a **"Version Packages"** PR created by the bot.
|
|
61
|
-
4. Merge that PR.
|
|
62
|
-
5. The release is now live on npm!
|
|
63
|
-
|
|
64
|
-
## Manual Verification (Optional)
|
|
65
|
-
|
|
66
|
-
Before publishing a new version you can run:
|
|
67
|
-
|
|
68
|
-
\`\`\`bash
|
|
69
|
-
bun run build:not-apps
|
|
70
|
-
npx npm-packlist --json packages/libs/contracts
|
|
71
|
-
\`\`\`
|
|
72
|
-
|
|
73
|
-
## Rollback
|
|
74
|
-
|
|
75
|
-
If a publish fails mid-way, re-run the workflow once the issue is fixed. Already published packages are skipped automatically. Use \`npm deprecate <package>@<version>\` if we need to warn consumers about a broken release.
|
|
76
|
-
`}]);
|
|
@@ -1,350 +0,0 @@
|
|
|
1
|
-
import{a as e}from"./registry.js";e([{id:`docs.accessibility_wcag_compliance_specs`,title:`Accessibility & WCAG Compliance — **specs.md**`,summary:`> **Goal:** Ship interfaces that are usable by everyone, by default. This spec sets non‑negotiable rules, checklists, and CI gates to meet **WCAG\xA02.2 AA** (aim for AAA where low‑cost), align with **EN\xA0301\xA0549** (EU), and keep parity on **web (Next.js)** and **mobile (Expo/React\xA0Native)**.`,kind:`reference`,visibility:`public`,route:`/docs/accessibility_wcag_compliance_specs`,tags:[`accessibility_wcag_compliance_specs`],body:`# Accessibility & WCAG Compliance — **specs.md**
|
|
2
|
-
|
|
3
|
-
> **Goal:** Ship interfaces that are usable by everyone, by default. This spec sets non‑negotiable rules, checklists, and CI gates to meet **WCAG\xA02.2 AA** (aim for AAA where low‑cost), align with **EN\xA0301\xA0549** (EU), and keep parity on **web (Next.js)** and **mobile (Expo/React\xA0Native)**.
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## 0) Scope & Principles
|
|
8
|
-
|
|
9
|
-
- **Standards:** WCAG\xA02.2\xA0AA (incl. new 2.2 SCs: Focus Not Obscured, Focus Appearance, Target Size, Dragging Movements, Accessible Authentication, Redundant Entry). EN\xA0301\xA0549 compliance by conformance to WCAG.
|
|
10
|
-
- **Principles:** Perceivable, Operable, Understandable, Robust (POUR).
|
|
11
|
-
- **Rule of ARIA:** “No ARIA is better than bad ARIA.” Prefer native elements.
|
|
12
|
-
- **Definition of Done (DoD):** No Critical/Major a11y issues in CI; keyboard complete; SR (screen reader) smoke test passed; contrasts pass; acceptance criteria below satisfied.
|
|
13
|
-
- **Repo Alignment:** Web apps use **Radix Primitives + shadcn** wrappers centralized in \`packages/lssm/libs/ui-kit-web\`. Prefer those components over per‑app duplicates (\`packages/*/apps/*/src/components/ui\`). When missing, add to \`ui-kit-web\` first, then adopt app‑side.
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## 1) Design Requirements (Design System & Tokens)
|
|
18
|
-
|
|
19
|
-
**1.1 Color & Contrast**
|
|
20
|
-
|
|
21
|
-
- Body text, icons essential to meaning: **≥\xA04.5:1**; large text (≥\xA018.66px regular / 14px bold): **≥\xA03:1**.
|
|
22
|
-
- Interactive states (default/hover/active/disabled/focus) must maintain contrast **≥\xA03:1** against adjacent colors; text within components follows text ratios.
|
|
23
|
-
- Provide light & dark themes with tokens that guarantee minimums. **Never rely solely on color** to convey meaning; pair with text, shape, or icon.
|
|
24
|
-
|
|
25
|
-
**1.2 Focus Indicators (WCAG\xA02.4.11/12)**
|
|
26
|
-
|
|
27
|
-
- Every interactive element has a **visible focus** with clear offset; indicator contrast **≥\xA03:1** vs adjacent colors and indicator **area ≥\xA02\xA0CSS\xA0px** thick.
|
|
28
|
-
- Focus **must not be obscured** by sticky headers/footers or scroll containers.
|
|
29
|
-
|
|
30
|
-
**1.3 Motion & Preferences**
|
|
31
|
-
|
|
32
|
-
- Respect \`prefers-reduced-motion\`: suppress large parallax, auto‑animations; provide instant alternatives.
|
|
33
|
-
- Avoid motion that could trigger vestibular issues; under PRM, use fade/scale under **150ms**.
|
|
34
|
-
|
|
35
|
-
**1.4 Target Size (2.5.8)**
|
|
36
|
-
|
|
37
|
-
- Hit areas **≥\xA024×24\xA0CSS\xA0px** (web) and **≥\xA044×44\xA0dp** (mobile) unless exempt.
|
|
38
|
-
|
|
39
|
-
**1.5 Typography & Layout**
|
|
40
|
-
|
|
41
|
-
- Support zoom to **400%** without loss of content/functionality; responsive reflow at **320\xA0CSS\xA0px** width.
|
|
42
|
-
- Maintain clear heading hierarchy (h1…h6), one **h1** per view.
|
|
43
|
-
|
|
44
|
-
- Repository baseline (Web): default body text uses Tailwind \`text-lg\` (≈18px). As of 2025‑09‑20, the repository bumped all Tailwind typography scale usages by +1 step (e.g., \`text-sm\`→\`text-base\`, \`text-base\`→\`text-lg\`, …, \`text-8xl\`→\`text-9xl\`). For long‑form content, default to \`prose-lg\`.
|
|
45
|
-
- Do not use \`text-xs\` for body copy. Reserve \`text-sm\` only for non‑essential meta (timestamps, fine print) while ensuring contrast and touch targets remain compliant.
|
|
46
|
-
- When increasing font size, ensure line height supports readability. Prefer Tailwind defaults or \`leading-relaxed\`/\`leading-7\` for body text where dense blocks appear.
|
|
47
|
-
|
|
48
|
-
**1.6 Iconography & Imagery**
|
|
49
|
-
|
|
50
|
-
- Decorative images: \`alt=""\` or \`aria-hidden="true"\`.
|
|
51
|
-
- Informative images: concise, specific **alt**; complex charts require a **data table or long description**.
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## 2) Content Requirements (UX Writing)
|
|
56
|
-
|
|
57
|
-
- Links say **what happens** (avoid “click here”).
|
|
58
|
-
- Buttons start with verbs; avoid ambiguous labels.
|
|
59
|
-
- Form labels are **visible**; placeholders are **not labels**.
|
|
60
|
-
- Error messages: human + programmatic association; avoid color‑only.
|
|
61
|
-
- Authentication: allow **copy/paste**, password managers, and avoid cognitive tests alone (**3.3.7/3.3.8/3.3.9**).
|
|
62
|
-
- Avoid CAPTCHAs that block users; if unavoidable, provide **multiple alternatives** (logic-free).
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
## 3) Engineering Requirements (Web — Next.js/React)
|
|
67
|
-
|
|
68
|
-
> Use and extend \`packages/lssm/libs/ui-kit-web\` as the default UI surface. It wraps **Radix** primitives with sensible a11y defaults (focus rings, roles, keyboard, ARIA binding). When a gap exists, add it to \`ui-kit-web\` first.
|
|
69
|
-
|
|
70
|
-
**3.1 Semantics & Landmarks**
|
|
71
|
-
|
|
72
|
-
- Use native elements: \`<button>\`, \`<a href>\`, \`<label for>\`, \`<fieldset>\`, \`<legend>\`, \`<table>\`, etc.
|
|
73
|
-
- Landmarks per page: \`header\`, \`nav\`, \`main\`, \`aside\`, \`footer\`. Provide a **Skip to main content** link.
|
|
74
|
-
- Provide a **Route Announcer** (\`aria-live="polite"\`) and move focus to page **h1** after navigation.
|
|
75
|
-
|
|
76
|
-
**3.2 Keyboard**
|
|
77
|
-
|
|
78
|
-
- All functionality available with keyboard alone. Tab order follows DOM/visual order; **no keyboard traps**.
|
|
79
|
-
- Common bindings:
|
|
80
|
-
- Space/Enter → activate button; Enter on link;
|
|
81
|
-
- Esc closes dialogs/menus;
|
|
82
|
-
- Arrow keys for lists/menus/tablists with **roving tabindex**.
|
|
83
|
-
|
|
84
|
-
**3.3 Focus Management**
|
|
85
|
-
|
|
86
|
-
- On route change (Next.js), move focus to the page \`<h1>\` or container and announce via a live region.
|
|
87
|
-
- Dialogs/menus: **trap focus** inside; return focus to invoking control on close.
|
|
88
|
-
- Don’t steal focus except after explicit user action.
|
|
89
|
-
|
|
90
|
-
**3.4 Forms**
|
|
91
|
-
|
|
92
|
-
- Each input has a \`<label>\` or \`aria-label\`. Group related inputs with \`<fieldset><legend>\`.
|
|
93
|
-
- Associate errors via \`aria-describedby\` or inline IDs; announce with \`role="alert"\` (assertive only for critical).
|
|
94
|
-
- Provide **autocomplete** tokens for known fields; show **inline validation** and do not block on **onBlur** alone.
|
|
95
|
-
|
|
96
|
-
**3.5 ARIA Usage**
|
|
97
|
-
|
|
98
|
-
- Only when needed; match patterns (dialog, menu, combobox, tablist, listbox) per ARIA Authoring Practices.
|
|
99
|
-
- Ensure **name/role/value** are programmatically determinable.
|
|
100
|
-
|
|
101
|
-
**3.6 Media**
|
|
102
|
-
|
|
103
|
-
- Videos: **captions**; provide **transcripts** for audio; audio descriptions for essential visual info.
|
|
104
|
-
- No auto‑playing audio. Auto‑playing video must be muted and pausable; provide controls.
|
|
105
|
-
|
|
106
|
-
**3.7 Tables & Data**
|
|
107
|
-
|
|
108
|
-
- Use \`<th scope>\` for headers; captions via \`<caption>\`; announce sorting via \`aria-sort\`.
|
|
109
|
-
- Provide CSV/JSON export where charts are primary.
|
|
110
|
-
|
|
111
|
-
**3.8 Performance & Robustness**
|
|
112
|
-
|
|
113
|
-
- Avoid content shifts that move focus; reserve space or use skeletons.
|
|
114
|
-
- Maintain accessible names through hydration/SSR; avoid \`dangerouslySetInnerHTML\` where possible.
|
|
115
|
-
|
|
116
|
-
**3.9 Next.js specifics**
|
|
117
|
-
|
|
118
|
-
- Use \`next/link\` for navigation; ensure links are **links**, not buttons.
|
|
119
|
-
- \`next/image\` must include **alt** (empty if decorative).
|
|
120
|
-
- Announce route changes with a **global live region** and shift focus to the new view.
|
|
121
|
-
|
|
122
|
-
**3.10 Accessibility library integration**
|
|
123
|
-
|
|
124
|
-
- Import \`@lssm/lib.accessibility\` at app root. It auto-imports its \`styles.css\` via the package entry; ensure bundlers keep CSS side effects. If your app tree-shakes CSS, explicitly import the stylesheet once in your root layout:
|
|
125
|
-
|
|
126
|
-
\`\`\`tsx
|
|
127
|
-
// app/layout.tsx
|
|
128
|
-
import '@lssm/lib.accessibility'; // includes tokens and provider exports
|
|
129
|
-
// or if needed: import '@lssm/lib.accessibility/src/styles.css';
|
|
130
|
-
\`\`\`
|
|
131
|
-
|
|
132
|
-
- Wrap the app with \`AccessibilityProvider\` and include an element with \`id="main"\` for the skip link target.
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## 3b) lssm/ui-kit-web — Component Patterns & Defaults
|
|
137
|
-
|
|
138
|
-
> Source: \`packages/lssm/libs/ui-kit-web/ui/*\`
|
|
139
|
-
|
|
140
|
-
- **Button/Input/Textarea**: Built‑in \`focus-visible\` rings; ensure visible labels via \`FormLabel\` or \`aria-label\`.
|
|
141
|
-
- **Form** (\`form.tsx\`): \`FormControl\` wires \`aria-invalid\` and \`aria-describedby\` to \`FormMessage\` and \`FormDescription\`. Prefer \`FormMessage\` for inline errors. Add \`role="alert"\` only for critical.
|
|
142
|
-
- **Dialog/Sheet/Dropdown**: Use Radix wrappers for focus‑trap and return‑focus. Provide \`DialogTitle\` + \`DialogDescription\` for name/description.
|
|
143
|
-
- **Select/Combobox**: Prefer \`SelectTrigger\` with visible label; for icon‑only triggers, supply \`aria-label\`. Document examples in each app.
|
|
144
|
-
- **Tabs**: Use \`TabsList\`, \`TabsTrigger\`, \`TabsContent\`; names are programmatically determinable.
|
|
145
|
-
- **Toast/Toaster**: Prefer non‑blocking announcements; map critical to assertive region; include action buttons with clear labels.
|
|
146
|
-
- **Table**: Use \`TableCaption\`; ensure \`TableHead\` cells use proper \`scope\`. Provide \`aria-sort\` on sortable headers.
|
|
147
|
-
- **Utilities to add (repo action)**:
|
|
148
|
-
- \`SkipLink\` component and pattern in layouts.
|
|
149
|
-
- \`RouteAnnouncer\` (\`aria-live="polite"\`) and **FocusOnRouteChange** helper.
|
|
150
|
-
- \`VisuallyHidden\` wrapper (Radix visually-hidden or minimal utility).
|
|
151
|
-
- \`useReducedMotion\` helper; honor in animated components.
|
|
152
|
-
- Touch‑size variants (≥44×44) for interactive atoms.
|
|
153
|
-
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
## 4) Engineering Requirements (Mobile — Expo/React\xA0Native)
|
|
157
|
-
|
|
158
|
-
- Set \`accessibilityLabel\`, \`accessibilityHint\`, and \`accessibilityRole\` on touchables.
|
|
159
|
-
- Ensure **hit slop** / min size **≥\xA044×44\xA0dp**.
|
|
160
|
-
- Support Dynamic Type / font scaling; no clipped text at **200%**.
|
|
161
|
-
- Respect **Invert Colors** and **Reduce Motion**; avoid flashing.
|
|
162
|
-
- Group related items with \`accessibilityElements\` ordering; hide decoration with \`accessible={false}\` or \`importantForAccessibility="no-hide-descendants"\` when appropriate.
|
|
163
|
-
- Test with **VoiceOver (iOS)** and **TalkBack (Android)**.
|
|
164
|
-
|
|
165
|
-
---
|
|
166
|
-
|
|
167
|
-
## 5) Component Patterns (Acceptance Rules)
|
|
168
|
-
|
|
169
|
-
**Buttons & Links**
|
|
170
|
-
|
|
171
|
-
- Use \`<button>\` for actions, \`<a href>\` for navigation. Provide disabled states that are perceivable beyond color.
|
|
172
|
-
|
|
173
|
-
**Navigation**
|
|
174
|
-
|
|
175
|
-
- Provide **Skip link**. One primary nav landmark. Indicate current page (\`aria-current="page"\`).
|
|
176
|
-
|
|
177
|
-
**Menus/Combobox/Autocomplete**
|
|
178
|
-
|
|
179
|
-
- Follow ARIA patterns: focus moves into list; \`aria-expanded\`, \`aria-controls\`, \`aria-activedescendant\` when applicable; Esc closes; typing filters.
|
|
180
|
-
|
|
181
|
-
**Modals/Dialogs**
|
|
182
|
-
|
|
183
|
-
- \`role="dialog"\` or \`alertdialog\` with **label**; focus trapped; background inert; Esc closes; return focus to trigger.
|
|
184
|
-
|
|
185
|
-
**Tabs**
|
|
186
|
-
|
|
187
|
-
- \`role="tablist"\`; tabs are in the tab order; arrow keys switch focus; content is \`role="tabpanel"\` with \`aria-labelledby\`.
|
|
188
|
-
|
|
189
|
-
**Toasts/Notifications**
|
|
190
|
-
|
|
191
|
-
- Non-critical: \`aria-live="polite"\`; critical: \`role="alert"\` sparingly.
|
|
192
|
-
|
|
193
|
-
**Infinite Scroll / “Load More”**
|
|
194
|
-
|
|
195
|
-
- Provide **Load more** control; announce new content to SR; preserve keyboard position.
|
|
196
|
-
|
|
197
|
-
**Drag & Drop (2.5.7)**
|
|
198
|
-
|
|
199
|
-
- Provide **non‑drag** alternative (e.g., move up/down buttons).
|
|
200
|
-
|
|
201
|
-
**Charts & Maps**
|
|
202
|
-
|
|
203
|
-
- Provide **table alternative** or textual summary; keyboard access to datapoints where interactive.
|
|
204
|
-
|
|
205
|
-
---
|
|
206
|
-
|
|
207
|
-
## 6) Testing & CI (Blocking Gates)
|
|
208
|
-
|
|
209
|
-
**Static & Unit**
|
|
210
|
-
|
|
211
|
-
- \`eslint-plugin-jsx-a11y\` — error on violations.
|
|
212
|
-
- \`jest-axe\` — unit tests for components.
|
|
213
|
-
|
|
214
|
-
**Automated Integration**
|
|
215
|
-
|
|
216
|
-
- \`axe-core\` via Playwright or Cypress on critical flows.
|
|
217
|
-
- \`pa11y-ci\` on key routes; threshold: **0 Critical / 0 Serious** to merge.
|
|
218
|
-
- Lighthouse CI a11y score **≥\xA095** on target pages.
|
|
219
|
-
|
|
220
|
-
**Manual QA (per release)**
|
|
221
|
-
|
|
222
|
-
- **Keyboard patrol:** navigate primary flows without mouse.
|
|
223
|
-
- **Screen reader smoke:** NVDA (Windows) or VoiceOver (macOS/iOS) across login, navigation, forms, dialogs.
|
|
224
|
-
- **Zoom & Reflow:** 200–400% & 320\xA0px width.
|
|
225
|
-
- **Color/Contrast check:** tokens in both themes.
|
|
226
|
-
|
|
227
|
-
**Reporting**
|
|
228
|
-
|
|
229
|
-
- A11y issues labeled: \`a11y-blocker\`, \`a11y-bug\`, \`a11y-enhancement\` with WCAG ref.
|
|
230
|
-
|
|
231
|
-
---
|
|
232
|
-
|
|
233
|
-
## 7) Repository‑Specific Adoption Plan
|
|
234
|
-
|
|
235
|
-
- Centralize UI usage on \`packages/lssm/libs/ui-kit-web\` and de‑duplicate per‑app \`components/ui\` where feasible.
|
|
236
|
-
- Introduce \`SkipLink\`, \`RouteAnnouncer\`, \`FocusOnRouteChange\`, and \`VisuallyHidden\` in \`ui-kit-web\`. Adopt in app layouts (\`app/layout.tsx\`) first.
|
|
237
|
-
- Add \`useReducedMotion\` and wire into animated components (e.g., \`drawer\`, \`tooltip\`, \`carousel\`).
|
|
238
|
-
- Add touch‑size variants to \`Button\`, \`IconButton\`, \`TabsTrigger\`, toggles.
|
|
239
|
-
- Document Select label patterns and error association in Forms.
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
## 8) Code Snippets
|
|
244
|
-
|
|
245
|
-
**Skip Link**
|
|
246
|
-
|
|
247
|
-
\`\`\`html
|
|
248
|
-
<a
|
|
249
|
-
class="sr-only focus:not-sr-only focus-visible:outline focus-visible:ring-4 focus-visible:ring-offset-2"
|
|
250
|
-
href="#main"
|
|
251
|
-
>Skip to main content</a
|
|
252
|
-
>
|
|
253
|
-
<main id="main">…</main>
|
|
254
|
-
\`\`\`
|
|
255
|
-
|
|
256
|
-
**Dialog (Radix + shadcn/ui) — essentials**
|
|
257
|
-
|
|
258
|
-
\`\`\`tsx
|
|
259
|
-
// Ensure label, description, focus trap, and return focus on close remain intact
|
|
260
|
-
<Dialog>
|
|
261
|
-
<DialogTrigger asChild>
|
|
262
|
-
<button aria-haspopup="dialog">Open settings</button>
|
|
263
|
-
</DialogTrigger>
|
|
264
|
-
<DialogContent aria-describedby="settings-desc">
|
|
265
|
-
<DialogTitle>Settings</DialogTitle>
|
|
266
|
-
<p id="settings-desc">Update your preferences.</p>
|
|
267
|
-
<DialogClose asChild>
|
|
268
|
-
<button>Close</button>
|
|
269
|
-
</DialogClose>
|
|
270
|
-
</DialogContent>
|
|
271
|
-
</Dialog>
|
|
272
|
-
\`\`\`
|
|
273
|
-
|
|
274
|
-
**Form error association**
|
|
275
|
-
|
|
276
|
-
\`\`\`tsx
|
|
277
|
-
<label htmlFor="email">Email</label>
|
|
278
|
-
<input id="email" name="email" type="email" aria-describedby="email-err" />
|
|
279
|
-
<p id="email-err" role="alert">Enter a valid email.</p>
|
|
280
|
-
\`\`\`
|
|
281
|
-
|
|
282
|
-
**Route change announcement (Next.js)**
|
|
283
|
-
|
|
284
|
-
\`\`\`tsx
|
|
285
|
-
// Add once at app root
|
|
286
|
-
<div
|
|
287
|
-
aria-live="polite"
|
|
288
|
-
aria-atomic="true"
|
|
289
|
-
id="route-announcer"
|
|
290
|
-
className="sr-only"
|
|
291
|
-
/>
|
|
292
|
-
\`\`\`
|
|
293
|
-
|
|
294
|
-
---
|
|
295
|
-
|
|
296
|
-
## 9) Exceptions & Waivers
|
|
297
|
-
|
|
298
|
-
- If a criterion cannot be met, file an issue with: context, attempted alternatives, WCAG reference, impact assessment, and a remediation date. **Temporary waivers only.**
|
|
299
|
-
|
|
300
|
-
---
|
|
301
|
-
|
|
302
|
-
## 10) Ownership
|
|
303
|
-
|
|
304
|
-
- **Design:** maintains token contrast, component specs.
|
|
305
|
-
- **Engineering:** enforces CI gates, implements patterns.
|
|
306
|
-
- **QA:** runs manual checks per release.
|
|
307
|
-
- **PM:** blocks release if AA not met on user‑visible flows.
|
|
308
|
-
|
|
309
|
-
---
|
|
310
|
-
|
|
311
|
-
## 11) References (internalize; no external dependency at runtime)
|
|
312
|
-
|
|
313
|
-
- WCAG\xA02.2 (AA), EN\xA0301\xA0549. ARIA Authoring Practices. Platform HIG (Apple, Material).
|
|
314
|
-
- \`packages/lssm/libs/ui-kit-web\` as the canonical UI source for web.
|
|
315
|
-
|
|
316
|
-
> **Bottom line:** Shipping means **accessible by default**. We don’t trade a11y for speed; we bake it into speed.
|
|
317
|
-
|
|
318
|
-
---
|
|
319
|
-
|
|
320
|
-
## 12) Adoption Status (2025-09-23)
|
|
321
|
-
|
|
322
|
-
- web-artisan: AccessibilityProvider integrated; sr-only/forced-colors applied; 44x44 targets; forms announce errors; jest-axe and cypress-axe in place.
|
|
323
|
-
- web-strit: AccessibilityProvider integrated; forced-colors, sr-only; forms announce errors; 44x44 targets; contrast tokens and text-scale wired; jest-axe and cypress-axe in place.
|
|
324
|
-
- web-coliving: AccessibilityProvider integrated; forced-colors and focus visibility added; text-scale wired; landing pages converted to \`Section\`/stacks with text-lg defaults; CTA capture standardized; ESLint guard for text-xs in main content; jest-axe and cypress-axe in place. Next: audit icon-only controls and ensure 44x44 targets; add role="alert" where critical.
|
|
325
|
-
|
|
326
|
-
> CI gates: run eslint a11y, jest-axe on components, and cypress-axe on critical flows per app.
|
|
327
|
-
|
|
328
|
-
---
|
|
329
|
-
|
|
330
|
-
## 13) CI Hardening & Visual QA
|
|
331
|
-
|
|
332
|
-
- Linting: Run eslint with jsx-a11y rules across all web apps; block on violations.
|
|
333
|
-
- Unit: Run jest-axe for ui-kit-web and app-level components.
|
|
334
|
-
- Integration: cypress-axe on key flows (auth, forms, dialogs, tables).
|
|
335
|
-
- Synthetic scans: pa11y-ci on critical pages (0 Critical/Serious policy).
|
|
336
|
-
- Performance/A11y audit: Lighthouse CI with a11y score >= 95 on target routes.
|
|
337
|
-
- Artifacts: Upload pa11y and Lighthouse reports per PR; annotate failures.
|
|
338
|
-
|
|
339
|
-
### Recent additions (2025-09-26)
|
|
340
|
-
|
|
341
|
-
- AutocompleteInput (groceries): Upgraded to ARIA combobox pattern with \`aria-controls\`, \`aria-activedescendant\`, \`Escape\`/\`Tab\` handling, and labelled listbox.
|
|
342
|
-
- Cypress a11y tests added for furniture and incidents modules on \`/modules\` and operators flows; checks run axe with critical/serious impacts.
|
|
343
|
-
|
|
344
|
-
## 14) Accessibility Telemetry (PostHog)
|
|
345
|
-
|
|
346
|
-
- Events (anonymized): a11y_pref_changed (text_scale, contrast_mode, reduce_motion), a11y_panel_opened.
|
|
347
|
-
- Properties: app, route, previous_value, new_value, timestamp.
|
|
348
|
-
- Dashboards: Adoption over time, per app/route; correlation with reduced bounce on forms.
|
|
349
|
-
- Privacy: No PII; aggregate only.
|
|
350
|
-
`}]);
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{a as e,i as t,o as n}from"./presentations.js";import{a as r,i,n as a}from"./registry.js";import"./PUBLISHING.docblock.js";import"./accessibility_wcag_compliance_specs.docblock.js";import"./tech/PHASE_1_QUICKSTART.docblock.js";import"./tech/PHASE_2_AI_NATIVE_OPERATIONS.docblock.js";import"./tech/PHASE_3_AUTO_EVOLUTION.docblock.js";import"./tech/PHASE_4_PERSONALIZATION_ENGINE.docblock.js";import"./tech/PHASE_5_ZERO_TOUCH_OPERATIONS.docblock.js";import"./tech/lifecycle-stage-system.docblock.js";import"./tech/presentation-runtime.docblock.js";import"./tech/auth/better-auth-nextjs.docblock.js";import"./tech/schema/README.docblock.js";import"./tech/templates/runtime.docblock.js";import"./tech/workflows/overview.docblock.js";import"./tech/mcp-endpoints.docblock.js";import"./tech/vscode-extension.docblock.js";import"./tech/telemetry-ingest.docblock.js";import"./tech/contracts/openapi-export.docblock.js";import"./tech/studio/workspaces.docblock.js";import"./tech/studio/sandbox-unlogged.docblock.js";import"./tech/studio/workspace-ops.docblock.js";import"./tech/studio/project-routing.docblock.js";import"./tech/studio/platform-admin-panel.docblock.js";import"./tech/studio/learning-events.docblock.js";import"./tech/studio/learning-journeys.docblock.js";import"./tech/studio/project-access-teams.docblock.js";import"./tech/studio/team-invitations.docblock.js";import"./tech/llm/llm-integration.docblock.js";
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
const e=[`markdown`,`application/json`,`application/xml`,`react`];function t(e){if(!e.length)return`/`;let t=e.startsWith(`/`)?e:`/${e}`;return t===`/`?`/`:t.replace(/\/+$/,``)}function n(e,n){if(e.route)return t(e.route);let r=n??`/docs`,i=e.id.replace(/^docs\.?/,``).replace(/\./g,`/`).replace(/\/+/g,`/`);return t(i.startsWith(`/`)?i:`${r}/${i}`)}function r(e,t){return t?`${t}.${e.id}`:e.id}function i(t,n){let i=n?.defaultTargets??e,a=t.version??n?.defaultVersion??1,o=t.stability??n?.defaultStability??`stable`;return{meta:{name:r(t,n?.namespace),version:a,description:t.summary??t.title,tags:t.tags,owners:t.owners,domain:t.domain,stability:o},policy:t.visibility&&t.visibility!==`public`?{flags:[t.visibility]}:void 0,source:{type:`blocknotejs`,docJson:t.body},targets:i}}function a(e,t){let n=e.version??t?.defaultVersion??1,i=e.stability??t?.defaultStability??`stable`;return{meta:{name:r(e,t?.namespace),version:n,stability:i,tags:e.tags,owners:e.owners,description:e.summary??e.title},content:{kind:`markdown`,content:e.body}}}function o(e,t){return e.map(e=>({block:e,route:n(e,t?.routePrefix),descriptor:i(e,t)}))}export{a,i,o};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{a as e,o as t}from"./presentations.js";var n=class{routes=new Map;constructor(e=[],t){e.forEach(e=>this.register(e,t))}register(e,n){let[r]=t([e],n);return r&&this.routes.set(e.id,r),this}list(){return[...this.routes.values()]}get(e){return this.routes.get(e)}toRouteTuples(){return this.list().map(({route:e,descriptor:t})=>[e,t])}toPresentationSpecs(t){return this.list().map(({block:n})=>e(n,t))}};const r=[`id`,`title`,`body`,`kind`,`visibility`,`route`],i=new n;function a(e){for(let t of e){for(let e of r)if(!t[e])throw Error(`DocBlock ${t.id??`<missing id>`} missing field ${String(e)}`);i.register(t)}}export{a,i,n};
|