summaryrefslogtreecommitdiff
path: root/packages/idb-bridge/src/util/canInjectKey.ts
blob: 903a9d3de5c36ed2831cc352100600bd6e0116c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/*
 Copyright 2017 Jeremy Scheff
 Copyright 20201 Taler Systems SA

 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 { IDBKeyPath } from "../idbtypes";

/**
 * Check that a key could be injected into a value.
 *
 * https://www.w3.org/TR/IndexedDB/#check-that-a-key-could-be-injected-into-a-value
 */
export function canInjectKey(
  keyPath: IDBKeyPath | IDBKeyPath[],
  value: any,
): boolean {
  if (Array.isArray(keyPath)) {
    throw new Error(
      "The key paths used in this section are always strings and never sequences, since it is not possible to create a object store which has a key generator and also has a key path that is a sequence.",
    );
  }

  const identifiers = keyPath.split(".");
  if (identifiers.length === 0) {
    throw new Error("Assert: identifiers is not empty");
  }
  identifiers.pop();

  for (const identifier of identifiers) {
    if (
      value === null ||
      (typeof value !== "object" && !Array.isArray(value))
    ) {
      return false;
    }

    const hop = value.hasOwnProperty(identifier);
    if (!hop) {
      return true;
    }

    value = value[identifier];
  }

  return value !== null && (typeof value === "object" || Array.isArray(value));
}