@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/@types/IIdentityServerProvider.js

@@ -0,0 +1 @@
+export {};

package/lib/@types/IIdentityServerProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentityServerProvider.js","names":[],"sources":["../../src/@types/IIdentityServerProvider.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nexport interface IIdentityServerProvider {\n    /**\n     * Gets an access token for use against the identity server,\n     * for the associated client.\n     * @returns Promise which resolves to the access token.\n     */\n    getAccessToken(): Promise<string | null>;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/@types/PushRules.d.ts

@@ -0,0 +1,140 @@
+export declare enum PushRuleActionName {
+    DontNotify = "dont_notify",
+    Notify = "notify",
+    Coalesce = "coalesce"
+}
+export declare enum TweakName {
+    Highlight = "highlight",
+    Sound = "sound"
+}
+export type Tweak<N extends TweakName, V> = {
+    set_tweak: N;
+    value?: V;
+};
+export type TweakHighlight = Tweak<TweakName.Highlight, boolean>;
+export type TweakSound = Tweak<TweakName.Sound, string>;
+export type Tweaks = TweakHighlight | TweakSound;
+export declare enum ConditionOperator {
+    ExactEquals = "==",
+    LessThan = "<",
+    GreaterThan = ">",
+    GreaterThanOrEqual = ">=",
+    LessThanOrEqual = "<="
+}
+export type PushRuleAction = Tweaks | PushRuleActionName;
+export type MemberCountCondition<N extends number, Op extends ConditionOperator = ConditionOperator.ExactEquals> = `${Op}${N}` | (Op extends ConditionOperator.ExactEquals ? `${N}` : never);
+export type AnyMemberCountCondition = MemberCountCondition<number, ConditionOperator>;
+export declare const DMMemberCountCondition: MemberCountCondition<2>;
+export declare function isDmMemberCountCondition(condition: AnyMemberCountCondition): boolean;
+export declare enum ConditionKind {
+    EventMatch = "event_match",
+    EventPropertyIs = "event_property_is",
+    EventPropertyContains = "event_property_contains",
+    ContainsDisplayName = "contains_display_name",
+    RoomMemberCount = "room_member_count",
+    SenderNotificationPermission = "sender_notification_permission",
+    CallStarted = "call_started",
+    CallStartedPrefix = "org.matrix.msc3914.call_started"
+}
+export interface IPushRuleCondition<N extends ConditionKind | string> {
+    [k: string]: any;
+    kind: N;
+}
+export interface IEventMatchCondition extends IPushRuleCondition<ConditionKind.EventMatch> {
+    key: string;
+    pattern?: string;
+    value?: string;
+}
+export interface IEventPropertyIsCondition extends IPushRuleCondition<ConditionKind.EventPropertyIs> {
+    key: string;
+    value: string | boolean | null | number;
+}
+export interface IEventPropertyContainsCondition extends IPushRuleCondition<ConditionKind.EventPropertyContains> {
+    key: string;
+    value: string | boolean | null | number;
+}
+export interface IContainsDisplayNameCondition extends IPushRuleCondition<ConditionKind.ContainsDisplayName> {
+}
+export interface IRoomMemberCountCondition extends IPushRuleCondition<ConditionKind.RoomMemberCount> {
+    is: AnyMemberCountCondition;
+}
+export interface ISenderNotificationPermissionCondition extends IPushRuleCondition<ConditionKind.SenderNotificationPermission> {
+    key: string;
+}
+export interface ICallStartedCondition extends IPushRuleCondition<ConditionKind.CallStarted> {
+}
+export interface ICallStartedPrefixCondition extends IPushRuleCondition<ConditionKind.CallStartedPrefix> {
+}
+export type PushRuleCondition = IEventMatchCondition | IEventPropertyIsCondition | IEventPropertyContainsCondition | IContainsDisplayNameCondition | IRoomMemberCountCondition | ISenderNotificationPermissionCondition | ICallStartedCondition | ICallStartedPrefixCondition;
+export declare enum PushRuleKind {
+    Override = "override",
+    ContentSpecific = "content",
+    RoomSpecific = "room",
+    SenderSpecific = "sender",
+    Underride = "underride"
+}
+export declare enum RuleId {
+    Master = ".m.rule.master",
+    IsUserMention = ".m.rule.is_user_mention",
+    IsRoomMention = ".m.rule.is_room_mention",
+    ContainsDisplayName = ".m.rule.contains_display_name",
+    ContainsUserName = ".m.rule.contains_user_name",
+    AtRoomNotification = ".m.rule.roomnotif",
+    DM = ".m.rule.room_one_to_one",
+    EncryptedDM = ".m.rule.encrypted_room_one_to_one",
+    Message = ".m.rule.message",
+    EncryptedMessage = ".m.rule.encrypted",
+    InviteToSelf = ".m.rule.invite_for_me",
+    MemberEvent = ".m.rule.member_event",
+    IncomingCall = ".m.rule.call",
+    SuppressNotices = ".m.rule.suppress_notices",
+    Tombstone = ".m.rule.tombstone",
+    PollStart = ".m.rule.poll_start",
+    PollStartUnstable = ".org.matrix.msc3930.rule.poll_start",
+    PollEnd = ".m.rule.poll_end",
+    PollEndUnstable = ".org.matrix.msc3930.rule.poll_end",
+    PollStartOneToOne = ".m.rule.poll_start_one_to_one",
+    PollStartOneToOneUnstable = ".org.matrix.msc3930.rule.poll_start_one_to_one",
+    PollEndOneToOne = ".m.rule.poll_end_one_to_one",
+    PollEndOneToOneUnstable = ".org.matrix.msc3930.rule.poll_end_one_to_one"
+}
+export type PushRuleSet = {
+    [k in PushRuleKind]?: IPushRule[];
+};
+export interface IPushRule {
+    actions: PushRuleAction[];
+    conditions?: PushRuleCondition[];
+    default: boolean;
+    enabled: boolean;
+    pattern?: string;
+    rule_id: RuleId | string;
+}
+export interface IAnnotatedPushRule extends IPushRule {
+    kind: PushRuleKind;
+}
+export interface IPushRules {
+    global: PushRuleSet;
+    device?: PushRuleSet;
+}
+export interface IPusher {
+    "app_display_name": string;
+    "app_id": string;
+    "data": {
+        format?: string;
+        url?: string;
+        brand?: string;
+    };
+    "device_display_name": string;
+    "kind": "http" | string;
+    "lang": string;
+    "profile_tag"?: string;
+    "pushkey": string;
+    "enabled"?: boolean | null;
+    "org.matrix.msc3881.enabled"?: boolean | null;
+    "device_id"?: string | null;
+    "org.matrix.msc3881.device_id"?: string | null;
+}
+export interface IPusherRequest extends Omit<IPusher, "device_id" | "org.matrix.msc3881.device_id"> {
+    append?: boolean;
+}
+//# sourceMappingURL=PushRules.d.ts.map

package/lib/@types/PushRules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushRules.d.ts","sourceRoot":"","sources":["../../src/@types/PushRules.ts"],"names":[],"mappings":"AAmBA,oBAAY,kBAAkB;IAC1B,UAAU,gBAAgB;IAC1B,MAAM,WAAW;IACjB,QAAQ,aAAa;CACxB;AAED,oBAAY,SAAS;IACjB,SAAS,cAAc;IACvB,KAAK,UAAU;CAClB;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,IAAI;IACxC,SAAS,EAAE,CAAC,CAAC;IACb,KAAK,CAAC,EAAE,CAAC,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,KAAK,CAAC,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AACjE,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAExD,MAAM,MAAM,MAAM,GAAG,cAAc,GAAG,UAAU,CAAC;AAEjD,oBAAY,iBAAiB;IACzB,WAAW,OAAO;IAClB,QAAQ,MAAM;IACd,WAAW,MAAM;IACjB,kBAAkB,OAAO;IACzB,eAAe,OAAO;CACzB;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,kBAAkB,CAAC;AAEzD,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,EAAE,EAAE,SAAS,iBAAiB,GAAG,iBAAiB,CAAC,WAAW,IACzG,GAAG,EAAE,GAAG,CAAC,EAAE,GACX,CAAC,EAAE,SAAS,iBAAiB,CAAC,WAAW,GAAG,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;AAElE,MAAM,MAAM,uBAAuB,GAAG,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;AAEtF,eAAO,MAAM,sBAAsB,EAAE,oBAAoB,CAAC,CAAC,CAAO,CAAC;AAEnE,wBAAgB,wBAAwB,CAAC,SAAS,EAAE,uBAAuB,GAAG,OAAO,CAEpF;AAED,oBAAY,aAAa;IACrB,UAAU,gBAAgB;IAC1B,eAAe,sBAAsB;IACrC,qBAAqB,4BAA4B;IACjD,mBAAmB,0BAA0B;IAC7C,eAAe,sBAAsB;IACrC,4BAA4B,mCAAmC;IAC/D,WAAW,iBAAiB;IAC5B,iBAAiB,oCAAoC;CACxD;AAED,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,aAAa,GAAG,MAAM;IAChE,CAAC,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjB,IAAI,EAAE,CAAC,CAAC;CACX;AAED,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,aAAa,CAAC,UAAU,CAAC;IACtF,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC;IAChG,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,+BAAgC,SAAQ,kBAAkB,CAAC,aAAa,CAAC,qBAAqB,CAAC;IAC5G,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,CAAC;CAC3C;AAED,MAAM,WAAW,6BAA8B,SAAQ,kBAAkB,CAAC,aAAa,CAAC,mBAAmB,CAAC;CAE3G;AAED,MAAM,WAAW,yBAA0B,SAAQ,kBAAkB,CAAC,aAAa,CAAC,eAAe,CAAC;IAChG,EAAE,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,sCACb,SAAQ,kBAAkB,CAAC,aAAa,CAAC,4BAA4B,CAAC;IACtE,GAAG,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB,CAAC,aAAa,CAAC,WAAW,CAAC;CAE3F;AAED,MAAM,WAAW,2BAA4B,SAAQ,kBAAkB,CAAC,aAAa,CAAC,iBAAiB,CAAC;CAEvG;AAID,MAAM,MAAM,iBAAiB,GACvB,oBAAoB,GACpB,yBAAyB,GACzB,+BAA+B,GAC/B,6BAA6B,GAC7B,yBAAyB,GACzB,sCAAsC,GACtC,qBAAqB,GACrB,2BAA2B,CAAC;AAElC,oBAAY,YAAY;IACpB,QAAQ,aAAa;IACrB,eAAe,YAAY;IAC3B,YAAY,SAAS;IACrB,cAAc,WAAW;IACzB,SAAS,cAAc;CAC1B;AAED,oBAAY,MAAM;IACd,MAAM,mBAAmB;IACzB,aAAa,4BAA4B;IACzC,aAAa,4BAA4B;IACzC,mBAAmB,kCAAkC;IACrD,gBAAgB,+BAA+B;IAC/C,kBAAkB,sBAAsB;IACxC,EAAE,4BAA4B;IAC9B,WAAW,sCAAsC;IACjD,OAAO,oBAAoB;IAC3B,gBAAgB,sBAAsB;IACtC,YAAY,0BAA0B;IACtC,WAAW,yBAAyB;IACpC,YAAY,iBAAiB;IAC7B,eAAe,6BAA6B;IAC5C,SAAS,sBAAsB;IAC/B,SAAS,uBAAuB;IAChC,iBAAiB,wCAAwC;IACzD,OAAO,qBAAqB;IAC5B,eAAe,sCAAsC;IACrD,iBAAiB,kCAAkC;IACnD,yBAAyB,mDAAmD;IAC5E,eAAe,gCAAgC;IAC/C,uBAAuB,iDAAiD;CAC3E;AAED,MAAM,MAAM,WAAW,GAAG;KACrB,CAAC,IAAI,YAAY,CAAC,CAAC,EAAE,SAAS,EAAE;CACpC,CAAC;AAEF,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,UAAU,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kBAAmB,SAAQ,SAAS;IACjD,IAAI,EAAE,YAAY,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,WAAW,OAAO;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,qBAAqB,EAAE,MAAM,CAAC;IAC9B,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,4BAA4B,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,8BAA8B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClD;AAED,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,8BAA8B,CAAC;IAC/F,MAAM,CAAC,EAAE,OAAO,CAAC;CACpB"}

package/lib/@types/PushRules.js

@@ -0,0 +1,94 @@
+/*
+Copyright 2021 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// allow camelcase as these are things that go onto the wire
+/* eslint-disable camelcase */
+
+export var PushRuleActionName = /*#__PURE__*/function (PushRuleActionName) {
+  PushRuleActionName["DontNotify"] = "dont_notify";
+  PushRuleActionName["Notify"] = "notify";
+  PushRuleActionName["Coalesce"] = "coalesce";
+  return PushRuleActionName;
+}({});
+export var TweakName = /*#__PURE__*/function (TweakName) {
+  TweakName["Highlight"] = "highlight";
+  TweakName["Sound"] = "sound";
+  return TweakName;
+}({});
+export var ConditionOperator = /*#__PURE__*/function (ConditionOperator) {
+  ConditionOperator["ExactEquals"] = "==";
+  ConditionOperator["LessThan"] = "<";
+  ConditionOperator["GreaterThan"] = ">";
+  ConditionOperator["GreaterThanOrEqual"] = ">=";
+  ConditionOperator["LessThanOrEqual"] = "<=";
+  return ConditionOperator;
+}({});
+export var DMMemberCountCondition = "2";
+export function isDmMemberCountCondition(condition) {
+  return condition === "==2" || condition === "2";
+}
+export var ConditionKind = /*#__PURE__*/function (ConditionKind) {
+  ConditionKind["EventMatch"] = "event_match";
+  ConditionKind["EventPropertyIs"] = "event_property_is";
+  ConditionKind["EventPropertyContains"] = "event_property_contains";
+  ConditionKind["ContainsDisplayName"] = "contains_display_name";
+  ConditionKind["RoomMemberCount"] = "room_member_count";
+  ConditionKind["SenderNotificationPermission"] = "sender_notification_permission";
+  ConditionKind["CallStarted"] = "call_started";
+  ConditionKind["CallStartedPrefix"] = "org.matrix.msc3914.call_started";
+  return ConditionKind;
+}({});
+
+// XXX: custom conditions are possible but always fail, and break the typescript discriminated union so ignore them here
+// IPushRuleCondition<Exclude<string, ConditionKind>> unfortunately does not resolve this at the time of writing.
+
+export var PushRuleKind = /*#__PURE__*/function (PushRuleKind) {
+  PushRuleKind["Override"] = "override";
+  PushRuleKind["ContentSpecific"] = "content";
+  PushRuleKind["RoomSpecific"] = "room";
+  PushRuleKind["SenderSpecific"] = "sender";
+  PushRuleKind["Underride"] = "underride";
+  return PushRuleKind;
+}({});
+export var RuleId = /*#__PURE__*/function (RuleId) {
+  RuleId["Master"] = ".m.rule.master";
+  RuleId["IsUserMention"] = ".m.rule.is_user_mention";
+  RuleId["IsRoomMention"] = ".m.rule.is_room_mention";
+  RuleId["ContainsDisplayName"] = ".m.rule.contains_display_name";
+  RuleId["ContainsUserName"] = ".m.rule.contains_user_name";
+  RuleId["AtRoomNotification"] = ".m.rule.roomnotif";
+  RuleId["DM"] = ".m.rule.room_one_to_one";
+  RuleId["EncryptedDM"] = ".m.rule.encrypted_room_one_to_one";
+  RuleId["Message"] = ".m.rule.message";
+  RuleId["EncryptedMessage"] = ".m.rule.encrypted";
+  RuleId["InviteToSelf"] = ".m.rule.invite_for_me";
+  RuleId["MemberEvent"] = ".m.rule.member_event";
+  RuleId["IncomingCall"] = ".m.rule.call";
+  RuleId["SuppressNotices"] = ".m.rule.suppress_notices";
+  RuleId["Tombstone"] = ".m.rule.tombstone";
+  RuleId["PollStart"] = ".m.rule.poll_start";
+  RuleId["PollStartUnstable"] = ".org.matrix.msc3930.rule.poll_start";
+  RuleId["PollEnd"] = ".m.rule.poll_end";
+  RuleId["PollEndUnstable"] = ".org.matrix.msc3930.rule.poll_end";
+  RuleId["PollStartOneToOne"] = ".m.rule.poll_start_one_to_one";
+  RuleId["PollStartOneToOneUnstable"] = ".org.matrix.msc3930.rule.poll_start_one_to_one";
+  RuleId["PollEndOneToOne"] = ".m.rule.poll_end_one_to_one";
+  RuleId["PollEndOneToOneUnstable"] = ".org.matrix.msc3930.rule.poll_end_one_to_one";
+  return RuleId;
+}({});
+
+/* eslint-enable camelcase */
+//# sourceMappingURL=PushRules.js.map

package/lib/@types/PushRules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushRules.js","names":["PushRuleActionName","TweakName","ConditionOperator","DMMemberCountCondition","isDmMemberCountCondition","condition","ConditionKind","PushRuleKind","RuleId"],"sources":["../../src/@types/PushRules.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n// allow camelcase as these are things that go onto the wire\n/* eslint-disable camelcase */\n\nexport enum PushRuleActionName {\n    DontNotify = \"dont_notify\",\n    Notify = \"notify\",\n    Coalesce = \"coalesce\",\n}\n\nexport enum TweakName {\n    Highlight = \"highlight\",\n    Sound = \"sound\",\n}\n\nexport type Tweak<N extends TweakName, V> = {\n    set_tweak: N;\n    value?: V;\n};\n\nexport type TweakHighlight = Tweak<TweakName.Highlight, boolean>;\nexport type TweakSound = Tweak<TweakName.Sound, string>;\n\nexport type Tweaks = TweakHighlight | TweakSound;\n\nexport enum ConditionOperator {\n    ExactEquals = \"==\",\n    LessThan = \"<\",\n    GreaterThan = \">\",\n    GreaterThanOrEqual = \">=\",\n    LessThanOrEqual = \"<=\",\n}\n\nexport type PushRuleAction = Tweaks | PushRuleActionName;\n\nexport type MemberCountCondition<N extends number, Op extends ConditionOperator = ConditionOperator.ExactEquals> =\n    | `${Op}${N}`\n    | (Op extends ConditionOperator.ExactEquals ? `${N}` : never);\n\nexport type AnyMemberCountCondition = MemberCountCondition<number, ConditionOperator>;\n\nexport const DMMemberCountCondition: MemberCountCondition<2> = \"2\";\n\nexport function isDmMemberCountCondition(condition: AnyMemberCountCondition): boolean {\n    return condition === \"==2\" || condition === \"2\";\n}\n\nexport enum ConditionKind {\n    EventMatch = \"event_match\",\n    EventPropertyIs = \"event_property_is\",\n    EventPropertyContains = \"event_property_contains\",\n    ContainsDisplayName = \"contains_display_name\",\n    RoomMemberCount = \"room_member_count\",\n    SenderNotificationPermission = \"sender_notification_permission\",\n    CallStarted = \"call_started\",\n    CallStartedPrefix = \"org.matrix.msc3914.call_started\",\n}\n\nexport interface IPushRuleCondition<N extends ConditionKind | string> {\n    [k: string]: any; // for custom conditions, there can be other fields here\n    kind: N;\n}\n\nexport interface IEventMatchCondition extends IPushRuleCondition<ConditionKind.EventMatch> {\n    key: string;\n    pattern?: string;\n    // Note that value property is an optimization for patterns which do not do\n    // any globbing and when the key is not \"content.body\".\n    value?: string;\n}\n\nexport interface IEventPropertyIsCondition extends IPushRuleCondition<ConditionKind.EventPropertyIs> {\n    key: string;\n    value: string | boolean | null | number;\n}\n\nexport interface IEventPropertyContainsCondition extends IPushRuleCondition<ConditionKind.EventPropertyContains> {\n    key: string;\n    value: string | boolean | null | number;\n}\n\nexport interface IContainsDisplayNameCondition extends IPushRuleCondition<ConditionKind.ContainsDisplayName> {\n    // no additional fields\n}\n\nexport interface IRoomMemberCountCondition extends IPushRuleCondition<ConditionKind.RoomMemberCount> {\n    is: AnyMemberCountCondition;\n}\n\nexport interface ISenderNotificationPermissionCondition\n    extends IPushRuleCondition<ConditionKind.SenderNotificationPermission> {\n    key: string;\n}\n\nexport interface ICallStartedCondition extends IPushRuleCondition<ConditionKind.CallStarted> {\n    // no additional fields\n}\n\nexport interface ICallStartedPrefixCondition extends IPushRuleCondition<ConditionKind.CallStartedPrefix> {\n    // no additional fields\n}\n\n// XXX: custom conditions are possible but always fail, and break the typescript discriminated union so ignore them here\n// IPushRuleCondition<Exclude<string, ConditionKind>> unfortunately does not resolve this at the time of writing.\nexport type PushRuleCondition =\n    | IEventMatchCondition\n    | IEventPropertyIsCondition\n    | IEventPropertyContainsCondition\n    | IContainsDisplayNameCondition\n    | IRoomMemberCountCondition\n    | ISenderNotificationPermissionCondition\n    | ICallStartedCondition\n    | ICallStartedPrefixCondition;\n\nexport enum PushRuleKind {\n    Override = \"override\",\n    ContentSpecific = \"content\",\n    RoomSpecific = \"room\",\n    SenderSpecific = \"sender\",\n    Underride = \"underride\",\n}\n\nexport enum RuleId {\n    Master = \".m.rule.master\",\n    IsUserMention = \".m.rule.is_user_mention\",\n    IsRoomMention = \".m.rule.is_room_mention\",\n    ContainsDisplayName = \".m.rule.contains_display_name\",\n    ContainsUserName = \".m.rule.contains_user_name\",\n    AtRoomNotification = \".m.rule.roomnotif\",\n    DM = \".m.rule.room_one_to_one\",\n    EncryptedDM = \".m.rule.encrypted_room_one_to_one\",\n    Message = \".m.rule.message\",\n    EncryptedMessage = \".m.rule.encrypted\",\n    InviteToSelf = \".m.rule.invite_for_me\",\n    MemberEvent = \".m.rule.member_event\",\n    IncomingCall = \".m.rule.call\",\n    SuppressNotices = \".m.rule.suppress_notices\",\n    Tombstone = \".m.rule.tombstone\",\n    PollStart = \".m.rule.poll_start\",\n    PollStartUnstable = \".org.matrix.msc3930.rule.poll_start\",\n    PollEnd = \".m.rule.poll_end\",\n    PollEndUnstable = \".org.matrix.msc3930.rule.poll_end\",\n    PollStartOneToOne = \".m.rule.poll_start_one_to_one\",\n    PollStartOneToOneUnstable = \".org.matrix.msc3930.rule.poll_start_one_to_one\",\n    PollEndOneToOne = \".m.rule.poll_end_one_to_one\",\n    PollEndOneToOneUnstable = \".org.matrix.msc3930.rule.poll_end_one_to_one\",\n}\n\nexport type PushRuleSet = {\n    [k in PushRuleKind]?: IPushRule[];\n};\n\nexport interface IPushRule {\n    actions: PushRuleAction[];\n    conditions?: PushRuleCondition[];\n    default: boolean;\n    enabled: boolean;\n    pattern?: string;\n    rule_id: RuleId | string;\n}\n\nexport interface IAnnotatedPushRule extends IPushRule {\n    kind: PushRuleKind;\n}\n\nexport interface IPushRules {\n    global: PushRuleSet;\n    device?: PushRuleSet;\n}\n\nexport interface IPusher {\n    \"app_display_name\": string;\n    \"app_id\": string;\n    \"data\": {\n        format?: string;\n        url?: string; // TODO: Required if kind==http\n        brand?: string; // TODO: For email notifications only? Unspecced field\n    };\n    \"device_display_name\": string;\n    \"kind\": \"http\" | string;\n    \"lang\": string;\n    \"profile_tag\"?: string;\n    \"pushkey\": string;\n    \"enabled\"?: boolean | null;\n    \"org.matrix.msc3881.enabled\"?: boolean | null;\n    \"device_id\"?: string | null;\n    \"org.matrix.msc3881.device_id\"?: string | null;\n}\n\nexport interface IPusherRequest extends Omit<IPusher, \"device_id\" | \"org.matrix.msc3881.device_id\"> {\n    append?: boolean;\n}\n\n/* eslint-enable camelcase */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;;AAEA,WAAYA,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA;AAM9B,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;AAerB,WAAYC,iBAAiB,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAgB7B,OAAO,IAAMC,sBAA+C,GAAG,GAAG;AAElE,OAAO,SAASC,wBAAwBA,CAACC,SAAkC,EAAW;EAClF,OAAOA,SAAS,KAAK,KAAK,IAAIA,SAAS,KAAK,GAAG;AACnD;AAEA,WAAYC,aAAa,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;;AAuDzB;AACA;;AAWA,WAAYC,YAAY,0BAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAZA,YAAY;EAAA,OAAZA,YAAY;AAAA;AAQxB,WAAYC,MAAM,0BAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAANA,MAAM;EAAA,OAANA,MAAM;AAAA;;AAuElB","ignoreList":[]}

package/lib/@types/another-json.d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"another-json.d.js","names":[],"sources":["../../src/@types/another-json.d.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\ndeclare module \"another-json\" {\n    export function stringify(o: object): string;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/@types/auth.d.ts

@@ -0,0 +1,208 @@
+import { UnstableValue } from "../NamespacedValue.ts";
+import { IClientWellKnown } from "../client.ts";
+/**
+ * Represents a response to the CSAPI `/refresh` endpoint.
+ */
+export interface IRefreshTokenResponse {
+    access_token: string;
+    expires_in_ms: number;
+    refresh_token: string;
+}
+/**
+ * Response to GET login flows as per https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3login
+ */
+export interface ILoginFlowsResponse {
+    flows: LoginFlow[];
+}
+export type LoginFlow = ISSOFlow | IPasswordFlow | ILoginFlow;
+export interface ILoginFlow {
+    type: string;
+}
+export interface IPasswordFlow extends ILoginFlow {
+    type: "m.login.password";
+}
+export declare const DELEGATED_OIDC_COMPATIBILITY: UnstableValue<"delegated_oidc_compatibility", "org.matrix.msc3824.delegated_oidc_compatibility">;
+/**
+ * Representation of SSO flow as per https://spec.matrix.org/v1.3/client-server-api/#client-login-via-sso
+ */
+export interface ISSOFlow extends ILoginFlow {
+    type: "m.login.sso" | "m.login.cas";
+    identity_providers?: IIdentityProvider[];
+    [DELEGATED_OIDC_COMPATIBILITY.name]?: boolean;
+    [DELEGATED_OIDC_COMPATIBILITY.altName]?: boolean;
+}
+export declare enum IdentityProviderBrand {
+    Gitlab = "gitlab",
+    Github = "github",
+    Apple = "apple",
+    Google = "google",
+    Facebook = "facebook",
+    Twitter = "twitter"
+}
+export interface IIdentityProvider {
+    id: string;
+    name: string;
+    icon?: string;
+    brand?: IdentityProviderBrand | string;
+}
+export declare enum SSOAction {
+    /** The user intends to login to an existing account */
+    LOGIN = "login",
+    /** The user intends to register for a new account */
+    REGISTER = "register"
+}
+/**
+ * A client can identify a user using their Matrix ID.
+ * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.
+ * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id
+ */
+type UserLoginIdentifier = {
+    type: "m.id.user";
+    user: string;
+};
+/**
+ * A client can identify a user using a 3PID associated with the user’s account on the homeserver,
+ * where the 3PID was previously associated using the /account/3pid API.
+ * See the 3PID Types Appendix for a list of Third-party ID media.
+ * @see https://spec.matrix.org/v1.7/client-server-api/#third-party-id
+ */
+type ThirdPartyLoginIdentifier = {
+    type: "m.id.thirdparty";
+    medium: string;
+    address: string;
+};
+/**
+ * A client can identify a user using a phone number associated with the user’s account,
+ * where the phone number was previously associated using the /account/3pid API.
+ * The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it.
+ * If the client wishes to canonicalise the phone number,
+ * then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.
+ *
+ * The country is the two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone should be parsed as if it were dialled from.
+ *
+ * @see https://spec.matrix.org/v1.7/client-server-api/#phone-number
+ */
+type PhoneLoginIdentifier = {
+    type: "m.id.phone";
+    country: string;
+    phone: string;
+};
+type SpecUserIdentifier = UserLoginIdentifier | ThirdPartyLoginIdentifier | PhoneLoginIdentifier;
+/**
+ * User Identifiers usable for login & user-interactive authentication.
+ *
+ * Extensibly allows more than Matrix specified identifiers.
+ */
+export type UserIdentifier = SpecUserIdentifier | {
+    type: Exclude<string, SpecUserIdentifier["type"]>;
+    [key: string]: any;
+};
+/**
+ * Request body for POST /login request
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login
+ */
+export interface LoginRequest {
+    /**
+     * The login type being used.
+     */
+    type: "m.login.password" | "m.login.token" | string;
+    /**
+     * ID of the client device.
+     * If this does not correspond to a known client device, a new device will be created.
+     * The given device ID must not be the same as a cross-signing key ID.
+     * The server will auto-generate a device_id if this is not specified.
+     */
+    device_id?: string;
+    /**
+     * Identification information for a user
+     */
+    identifier?: UserIdentifier;
+    /**
+     * A display name to assign to the newly-created device.
+     * Ignored if device_id corresponds to a known device.
+     */
+    initial_device_display_name?: string;
+    /**
+     * When logging in using a third-party identifier, the medium of the identifier.
+     * Must be `email`.
+     * @deprecated in favour of `identifier`.
+     */
+    medium?: "email";
+    /**
+     * Required when type is `m.login.password`. The user’s password.
+     */
+    password?: string;
+    /**
+     * If true, the client supports refresh tokens.
+     */
+    refresh_token?: boolean;
+    /**
+     * Required when type is `m.login.token`. Part of Token-based login.
+     */
+    token?: string;
+    /**
+     * The fully qualified user ID or just local part of the user ID, to log in.
+     * @deprecated in favour of identifier.
+     */
+    user?: string;
+    [key: string]: any;
+}
+export type ILoginParams = LoginRequest;
+/**
+ * Response body for POST /login request
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login
+ */
+export interface LoginResponse {
+    /**
+     * An access token for the account.
+     * This access token can then be used to authorize other requests.
+     */
+    access_token: string;
+    /**
+     * ID of the logged-in device.
+     * Will be the same as the corresponding parameter in the request, if one was specified.
+     */
+    device_id: string;
+    /**
+     * The fully-qualified Matrix ID for the account.
+     */
+    user_id: string;
+    /**
+     * The lifetime of the access token, in milliseconds.
+     * Once the access token has expired a new access token can be obtained by using the provided refresh token.
+     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.
+     * If not given, the client can assume that the access token will not expire.
+     */
+    expires_in_ms?: number;
+    /**
+     * A refresh token for the account.
+     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.
+     */
+    refresh_token?: string;
+    /**
+     * Optional client configuration provided by the server.
+     * If present, clients SHOULD use the provided object to reconfigure themselves, optionally validating the URLs within.
+     * This object takes the same form as the one returned from .well-known autodiscovery.
+     */
+    well_known?: IClientWellKnown;
+    /**
+     * The server_name of the homeserver on which the account has been registered.
+     * @deprecated Clients should extract the server_name from user_id (by splitting at the first colon) if they require it.
+     */
+    home_server?: string;
+}
+/**
+ * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token
+ */
+export interface LoginTokenPostResponse {
+    /**
+     * The token to use with `m.login.token` to authenticate.
+     */
+    login_token: string;
+    /**
+     * Expiration in milliseconds.
+     */
+    expires_in_ms: number;
+}
+export {};
+//# sourceMappingURL=auth.d.ts.map

package/lib/@types/auth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../src/@types/auth.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAKhD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;CACzB;AAID;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,aAAa,GAAG,UAAU,CAAC;AAE9D,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;IAC7C,IAAI,EAAE,kBAAkB,CAAC;CAC5B;AAED,eAAO,MAAM,4BAA4B,kGAGxC,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,UAAU;IACxC,IAAI,EAAE,aAAa,GAAG,aAAa,CAAC;IAEpC,kBAAkB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACzC,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC;IAC9C,CAAC,4BAA4B,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC;CACpD;AAED,oBAAY,qBAAqB;IAC7B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;CACtB;AAED,MAAM,WAAW,iBAAiB;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAAC;CAC1C;AAED,oBAAY,SAAS;IACjB,uDAAuD;IACvD,KAAK,UAAU;IAEf,qDAAqD;IACrD,QAAQ,aAAa;CACxB;AAED;;;;GAIG;AACH,KAAK,mBAAmB,GAAG;IACvB,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;GAKG;AACH,KAAK,yBAAyB,GAAG;IAC7B,IAAI,EAAE,iBAAiB,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,KAAK,oBAAoB,GAAG;IACxB,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,KAAK,kBAAkB,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,oBAAoB,CAAC;AAEjG;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,kBAAkB,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB;;OAEG;IACH,IAAI,EAAE,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAAC;IACpD;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAGD,MAAM,MAAM,YAAY,GAAG,YAAY,CAAC;AAExC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;IAC9B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACzB"}

package/lib/@types/auth.js

@@ -0,0 +1,99 @@
+/*
+Copyright 2022 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { UnstableValue } from "../NamespacedValue.js";
+
+// disable lint because these are wire responses
+/* eslint-disable camelcase */
+
+/**
+ * Represents a response to the CSAPI `/refresh` endpoint.
+ */
+
+/* eslint-enable camelcase */
+
+/**
+ * Response to GET login flows as per https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3login
+ */
+
+export var DELEGATED_OIDC_COMPATIBILITY = new UnstableValue("delegated_oidc_compatibility", "org.matrix.msc3824.delegated_oidc_compatibility");
+
+/**
+ * Representation of SSO flow as per https://spec.matrix.org/v1.3/client-server-api/#client-login-via-sso
+ */
+
+export var IdentityProviderBrand = /*#__PURE__*/function (IdentityProviderBrand) {
+  IdentityProviderBrand["Gitlab"] = "gitlab";
+  IdentityProviderBrand["Github"] = "github";
+  IdentityProviderBrand["Apple"] = "apple";
+  IdentityProviderBrand["Google"] = "google";
+  IdentityProviderBrand["Facebook"] = "facebook";
+  IdentityProviderBrand["Twitter"] = "twitter";
+  return IdentityProviderBrand;
+}({});
+export var SSOAction = /*#__PURE__*/function (SSOAction) {
+  SSOAction["LOGIN"] = "login";
+  SSOAction["REGISTER"] = "register";
+  return SSOAction;
+}({});
+
+/**
+ * A client can identify a user using their Matrix ID.
+ * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.
+ * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id
+ */
+
+/**
+ * A client can identify a user using a 3PID associated with the user’s account on the homeserver,
+ * where the 3PID was previously associated using the /account/3pid API.
+ * See the 3PID Types Appendix for a list of Third-party ID media.
+ * @see https://spec.matrix.org/v1.7/client-server-api/#third-party-id
+ */
+
+/**
+ * A client can identify a user using a phone number associated with the user’s account,
+ * where the phone number was previously associated using the /account/3pid API.
+ * The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it.
+ * If the client wishes to canonicalise the phone number,
+ * then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.
+ *
+ * The country is the two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone should be parsed as if it were dialled from.
+ *
+ * @see https://spec.matrix.org/v1.7/client-server-api/#phone-number
+ */
+
+/**
+ * User Identifiers usable for login & user-interactive authentication.
+ *
+ * Extensibly allows more than Matrix specified identifiers.
+ */
+
+/**
+ * Request body for POST /login request
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login
+ */
+
+// Export for backwards compatibility
+
+/**
+ * Response body for POST /login request
+ * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login
+ */
+
+/**
+ * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token
+ */
+//# sourceMappingURL=auth.js.map

package/lib/@types/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","names":["UnstableValue","DELEGATED_OIDC_COMPATIBILITY","IdentityProviderBrand","SSOAction"],"sources":["../../src/@types/auth.ts"],"sourcesContent":["/*\nCopyright 2022 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { UnstableValue } from \"../NamespacedValue.ts\";\nimport { IClientWellKnown } from \"../client.ts\";\n\n// disable lint because these are wire responses\n/* eslint-disable camelcase */\n\n/**\n * Represents a response to the CSAPI `/refresh` endpoint.\n */\nexport interface IRefreshTokenResponse {\n    access_token: string;\n    expires_in_ms: number;\n    refresh_token: string;\n}\n\n/* eslint-enable camelcase */\n\n/**\n * Response to GET login flows as per https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv3login\n */\nexport interface ILoginFlowsResponse {\n    flows: LoginFlow[];\n}\n\nexport type LoginFlow = ISSOFlow | IPasswordFlow | ILoginFlow;\n\nexport interface ILoginFlow {\n    type: string;\n}\n\nexport interface IPasswordFlow extends ILoginFlow {\n    type: \"m.login.password\";\n}\n\nexport const DELEGATED_OIDC_COMPATIBILITY = new UnstableValue(\n    \"delegated_oidc_compatibility\",\n    \"org.matrix.msc3824.delegated_oidc_compatibility\",\n);\n\n/**\n * Representation of SSO flow as per https://spec.matrix.org/v1.3/client-server-api/#client-login-via-sso\n */\nexport interface ISSOFlow extends ILoginFlow {\n    type: \"m.login.sso\" | \"m.login.cas\";\n    // eslint-disable-next-line camelcase\n    identity_providers?: IIdentityProvider[];\n    [DELEGATED_OIDC_COMPATIBILITY.name]?: boolean;\n    [DELEGATED_OIDC_COMPATIBILITY.altName]?: boolean;\n}\n\nexport enum IdentityProviderBrand {\n    Gitlab = \"gitlab\",\n    Github = \"github\",\n    Apple = \"apple\",\n    Google = \"google\",\n    Facebook = \"facebook\",\n    Twitter = \"twitter\",\n}\n\nexport interface IIdentityProvider {\n    id: string;\n    name: string;\n    icon?: string;\n    brand?: IdentityProviderBrand | string;\n}\n\nexport enum SSOAction {\n    /** The user intends to login to an existing account */\n    LOGIN = \"login\",\n\n    /** The user intends to register for a new account */\n    REGISTER = \"register\",\n}\n\n/**\n * A client can identify a user using their Matrix ID.\n * This can either be the fully qualified Matrix user ID, or just the localpart of the user ID.\n * @see https://spec.matrix.org/v1.7/client-server-api/#matrix-user-id\n */\ntype UserLoginIdentifier = {\n    type: \"m.id.user\";\n    user: string;\n};\n\n/**\n * A client can identify a user using a 3PID associated with the user’s account on the homeserver,\n * where the 3PID was previously associated using the /account/3pid API.\n * See the 3PID Types Appendix for a list of Third-party ID media.\n * @see https://spec.matrix.org/v1.7/client-server-api/#third-party-id\n */\ntype ThirdPartyLoginIdentifier = {\n    type: \"m.id.thirdparty\";\n    medium: string;\n    address: string;\n};\n\n/**\n * A client can identify a user using a phone number associated with the user’s account,\n * where the phone number was previously associated using the /account/3pid API.\n * The phone number can be passed in as entered by the user; the homeserver will be responsible for canonicalising it.\n * If the client wishes to canonicalise the phone number,\n * then it can use the m.id.thirdparty identifier type with a medium of msisdn instead.\n *\n * The country is the two-letter uppercase ISO-3166-1 alpha-2 country code that the number in phone should be parsed as if it were dialled from.\n *\n * @see https://spec.matrix.org/v1.7/client-server-api/#phone-number\n */\ntype PhoneLoginIdentifier = {\n    type: \"m.id.phone\";\n    country: string;\n    phone: string;\n};\n\ntype SpecUserIdentifier = UserLoginIdentifier | ThirdPartyLoginIdentifier | PhoneLoginIdentifier;\n\n/**\n * User Identifiers usable for login & user-interactive authentication.\n *\n * Extensibly allows more than Matrix specified identifiers.\n */\nexport type UserIdentifier =\n    | SpecUserIdentifier\n    | { type: Exclude<string, SpecUserIdentifier[\"type\"]>; [key: string]: any };\n\n/**\n * Request body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginRequest {\n    /**\n     * The login type being used.\n     */\n    type: \"m.login.password\" | \"m.login.token\" | string;\n    /**\n     * ID of the client device.\n     * If this does not correspond to a known client device, a new device will be created.\n     * The given device ID must not be the same as a cross-signing key ID.\n     * The server will auto-generate a device_id if this is not specified.\n     */\n    device_id?: string;\n    /**\n     * Identification information for a user\n     */\n    identifier?: UserIdentifier;\n    /**\n     * A display name to assign to the newly-created device.\n     * Ignored if device_id corresponds to a known device.\n     */\n    initial_device_display_name?: string;\n    /**\n     * When logging in using a third-party identifier, the medium of the identifier.\n     * Must be `email`.\n     * @deprecated in favour of `identifier`.\n     */\n    medium?: \"email\";\n    /**\n     * Required when type is `m.login.password`. The user’s password.\n     */\n    password?: string;\n    /**\n     * If true, the client supports refresh tokens.\n     */\n    refresh_token?: boolean;\n    /**\n     * Required when type is `m.login.token`. Part of Token-based login.\n     */\n    token?: string;\n    /**\n     * The fully qualified user ID or just local part of the user ID, to log in.\n     * @deprecated in favour of identifier.\n     */\n    user?: string;\n    // Extensible\n    [key: string]: any;\n}\n\n// Export for backwards compatibility\nexport type ILoginParams = LoginRequest;\n\n/**\n * Response body for POST /login request\n * @see https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv3login\n */\nexport interface LoginResponse {\n    /**\n     * An access token for the account.\n     * This access token can then be used to authorize other requests.\n     */\n    access_token: string;\n    /**\n     * ID of the logged-in device.\n     * Will be the same as the corresponding parameter in the request, if one was specified.\n     */\n    device_id: string;\n    /**\n     * The fully-qualified Matrix ID for the account.\n     */\n    user_id: string;\n    /**\n     * The lifetime of the access token, in milliseconds.\n     * Once the access token has expired a new access token can be obtained by using the provided refresh token.\n     * If no refresh token is provided, the client will need to re-log in to obtain a new access token.\n     * If not given, the client can assume that the access token will not expire.\n     */\n    expires_in_ms?: number;\n    /**\n     * A refresh token for the account.\n     * This token can be used to obtain a new access token when it expires by calling the /refresh endpoint.\n     */\n    refresh_token?: string;\n    /**\n     * Optional client configuration provided by the server.\n     * If present, clients SHOULD use the provided object to reconfigure themselves, optionally validating the URLs within.\n     * This object takes the same form as the one returned from .well-known autodiscovery.\n     */\n    well_known?: IClientWellKnown;\n    /**\n     * The server_name of the homeserver on which the account has been registered.\n     * @deprecated Clients should extract the server_name from user_id (by splitting at the first colon) if they require it.\n     */\n    home_server?: string;\n}\n\n/**\n * The result of a successful `m.login.token` issuance request as per https://spec.matrix.org/v1.7/client-server-api/#post_matrixclientv1loginget_token\n */\nexport interface LoginTokenPostResponse {\n    /**\n     * The token to use with `m.login.token` to authenticate.\n     */\n    login_token: string;\n    /**\n     * Expiration in milliseconds.\n     */\n    expires_in_ms: number;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,aAAa,QAAQ,uBAAuB;;AAGrD;AACA;;AAEA;AACA;AACA;;AAOA;;AAEA;AACA;AACA;;AAeA,OAAO,IAAMC,4BAA4B,GAAG,IAAID,aAAa,CACzD,8BAA8B,EAC9B,iDACJ,CAAC;;AAED;AACA;AACA;;AASA,WAAYE,qBAAqB,0BAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAArBA,qBAAqB;EAAA,OAArBA,qBAAqB;AAAA;AAgBjC,WAAYC,SAAS,0BAATA,SAAS;EAATA,SAAS;EAATA,SAAS;EAAA,OAATA,SAAS;AAAA;;AAQrB;AACA;AACA;AACA;AACA;;AAMA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AASA;AACA;AACA;AACA;AACA;;AAKA;AACA;AACA;AACA;;AAiDA;;AAGA;AACA;AACA;AACA;;AAyCA;AACA;AACA","ignoreList":[]}